slackr_setup: Setup environment variables for Slack API access

In tmooney101/slacktest003: Send Messages, Images, R Objects and Files to 'Slack' Channels/Users

Description

Initialize all the environment variables slackr will need to use to work properly.

Usage

slackr_setup(channel = "#general", username = "slackr", icon_emoji = "",
  incoming_webhook_url = "", api_token = "", config_file = "~/.slackr",
  echo = FALSE)

slackrSetup(channel = "#general", username = "slackr", icon_emoji = "",
  incoming_webhook_url = "", api_token = "", config_file = "~/.slackr",
  echo = FALSE)

Arguments

channel	default channel to send the output to (chr) defaults to #general
username	the username output will appear from (chr) defaults to slackr
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.com URL prefix to use (chr) defaults to none
api_token	the Slack full API token (chr)
config_file	a configuration file (DCF) - see read.dcf - format with the config values.
echo	display the configuration variables (bool) initially FALSE

Details

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:

 api_token: YOUR_FULL_API_TOKEN
 channel: #general
 username: slackr
 incoming_webhook_url: https://hooks.slack.com/services/XXXXX/XXXXX/XXXXX

Note

You need a Slack account and all your API URLs & tokens setup to use this package.

See Also

slackr, dev_slackr, save_slackr, slackr_upload

Examples

## 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)

tmooney101/slacktest003 documentation built on May 31, 2019, 4:39 p.m.