# telegram v0.6.0

0

0th

Percentile

## R Wrapper Around the Telegram Bot API

R wrapper around the Telegram Bot API (http://core.telegram.org/bots/api) to access Telegram's messaging facilities with ease (e.g. you send messages, images, files from R to your smartphone).

# telegram

This package is an R wrapper around the Telegram Bot API.

It allows to send messages (text, Markdown, images, files) from R to your smartphone.

More infos on telegram's bot api can be found here and here.

## How to install the package?

For the stable version:

install.packages('telegram')


For the development one:

devtools::install_github('lbraglia/telegram')


## First time setup

First you have to talk to the botfather to create a new bot; answer few questions regarding bot's name and you're ready to go.

After you've done, the botfather returns a token (which has to be kept secret) that lets you handle your bot; we need this token when creating the bot object on the R side. Following Hadley's API guidelines it's unsafe to type the token just in the R script. It's better to use enviroment variables set in .Renviron file.

So let's say you have named your bot RBot (it's the first question you've answered to the botfather); then put the following line with your token in your .Renviron:

R_TELEGRAM_BOT_RBot=123123:asdasdasd


If you follow the suggested R_TELEGRAM_BOT_ prefix convention you'll be able to use the bot_token function (otherwise you'll have to get these variable from Sys.getenv).

After you've finished these steps restart R in order to have working environment variables.

## How to connect R with Telegram

Now you should be able to obtain a connection to your bot with these commands:

library(telegram)

## Create the bot object
bot <- TGBot$new(token = bot_token('RBot')) ## Now check bot connection it should print some of your bot's data bot$getMe()

## Now, on the phone, find and say something to your bot to start a chat
## (and obtain a chat id).
## ...

## Here, check what you have inserted
bot$getUpdates() ## You're interested in the message.chat.id variable: in order to set a ## default chat_id for the following commands (to ease typing) bot$set_default_chat_id(123456789)


After a bit using the package, you'll probably want to set the chat_id to your user id (or more generally, have something like an addressbook to store users' ids). If you put this in your .Renviron:

R_TELEGRAM_USER_me=123456789


you'll be able to use the user_id function, eg like this:

bot$set_default_chat_id(user_id('me'))  ## Examples of methods currently implemented Once you've followed the previous section, run the following commands and look at your phone. ## Send some messages.. bot$sendMessage('This is text')
## Markdown support for messages
md1 <- "*bold* _italic_ [r-project](http://r-project.org) "
md2 <- " try x <- rnorm(100) at the console ..."
## below left spaces just for github displaying (not needed in the .R src)
md3 <- "
you can have

x <- runif(100)
mean(x)





## Functions in telegram

 Name Description getUserProfilePhotos getUserProfilePhotos sendLocation sendLocation getMe getMe sendMessage sendMessage bot_token bot_token sendAudio sendAudio getUpdates getUpdates getFile getFile sendDocument sendDocument forwardMessage forwardMessage telegram telegram. sendVideo sendVideo TGBot TGBot sendVoice sendVoice user_id user_id sendSticker sendSticker sendPhoto sendPhoto No Results!