create_config_file: Create the config file used in 'slackr_setup()'

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

Create the config file used in slackr_setup()

Description

Create the config file used in slackr_setup()

Usage

create_config_file(
  filename = "~/.slackr",
  token = Sys.getenv("SLACK_TOKEN"),
  incoming_webhook_url = Sys.getenv("SLACK_INCOMING_WEBHOOK_URL"),
  icon_emoji = Sys.getenv("SLACK_ICON_EMOJI"),
  username = Sys.getenv("SLACK_USERNAME"),
  channel = Sys.getenv("SLACK_CHANNEL")
)

Arguments

filename	the name of the config file to save. We recommend using a hidden file (starting with '.')
token	Authentication token bearing required scopes.
incoming_webhook_url	the incoming webhook URL (Default: whatever is set as an env var).
icon_emoji	the icon emoji to use as the default.
username	the username to send messages from (will default to "slackr" if no username is set).
channel	Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See the chat.postMessage endpoint documentation for details.

Value

TRUE if successful (invisibly)

See Also

slackr_setup()

Examples

## Not run: 
# using `create_config_file()` after `slackr_setup()`
create_config_file()

# using `create_config_file()` before `slackr_setup()`
create_config_file(
  token = "xox-",
  incoming_webhook_url = "https://hooks-",
  channel = "#general",
  username = "slackr",
  icon_emoji = "tada"
)

slackr_setup()

## End(Not run)

hrbrmstr/slackr documentation built on Oct. 17, 2024, 11:31 a.m.