slackr_setup | R Documentation |
Initialize all the environment variables slackr()
will need to use to
work properly.
slackr_setup( channel = "#general", username = "slackr", icon_emoji = "", incoming_webhook_url = "", token = "", config_file = "~/.slackr", echo = FALSE, cache_dir = "" )
channel |
default channel to send the output to (chr) defaults to |
username |
the username output will appear from (chr) defaults to |
icon_emoji |
which emoji picture to use (chr) defaults to none (can be left blank in config file as well). |
incoming_webhook_url |
the Slack URL prefix to use (chr) defaults to none. |
token |
Authentication token bearing required scopes. |
config_file |
a configuration file (DCF) - see read.dcf - format with the config values. |
echo |
display the configuration variables (bool) initially |
cache_dir |
the location for an on-disk cache. defaults to an in-memory cache if no location is specified. |
By default, slackr()
(and other functions) will use the #general
room and a username of slackr()
with no emoji.
If a valid file is found at the locaiton pointed to by config_file
, the
values there will be used. The fields should be specified as such in the file:
token: SLACK_TOKEN channel: #general username: slackr incoming_webhook_url: https://hooks.slack.com/services/XXXXX/XXXXX/XXXXX
"Successfully connected to Slack"
You need a Slack account and all your API URLs & tokens setup to use this package.
slackr()
, slackr_dev()
, slackr_save()
,
slackr_upload()
## Not run: # reads from default file (i.e. ~/.slackr) slackr_setup() # reads from alternate config slackr_setup(config_file = "/path/to/my/slackrconfig") # the hard way slackr_setup( channel = "#code", incoming_webhook_url = "https://hooks.slack.com/services/XXXXX/XXXXX/XXXXX" ) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.