Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Arguments

Value

The result of calling rhs(lhs).

Checks authentication & identity against the Slack API.

Description

Checks authentication & identity against the Slack API.

Usage

auth_test(token = Sys.getenv("SLACK_TOKEN"))

Arguments

References

https://api.slack.com/methods/auth.test

Examples

if (Sys.getenv("SLACK_TOKEN") != "") {
  auth_test()
}

A wrapper function to call the Slack API with authentication and pagination.

Description

A wrapper function to call the Slack API with authentication and pagination.

Usage

call_slack_api(
  path,
  ...,
  body = NULL,
  .method = c("GET", "POST"),
  token,
  .verbose = Sys.getenv("SLACKR_VERBOSE", "FALSE"),
  .next_cursor = ""
)

Arguments

Value

The API response (a named list)

Convert Slack API json response to tibble.

Description

Convert Slack API json response to tibble.

Usage

convert_response_to_tibble(x, element)

Arguments

Value

A tibble

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

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)

Post a ggplot to a Slack channel

Description

Unlike the slackr_dev() function, this one takes a ggplot object, eliminating the need to have a graphics device (think use in scripts).

Usage

ggslackr(
  plot = ggplot2::last_plot(),
  channels = Sys.getenv("SLACK_CHANNEL"),
  token = Sys.getenv("SLACK_TOKEN"),
  file = "ggplot.png",
  initial_comment = NULL,
  thread_ts = NULL,
  title = NULL,
  ...
)

Arguments

Value

httr response object (invisibly)

Examples

## Not run: 
slackr_setup()
ggslackr(qplot(mpg, wt, data = mtcars))

## End(Not run)

Append slackr_msg as on.exit to functions.

Description

Appends to the body of a function an on.exit call to run at the end of the call.

Usage

register_onexit(
  f,
  ...,
  header_msg = NULL,
  use_device = FALSE,
  env = parent.frame(2),
  channel = Sys.getenv("SLACK_CHANNEL"),
  username = Sys.getenv("SLACK_USERNAME"),
  icon_emoji = Sys.getenv("SLACK_ICON_EMOJI"),
  token = Sys.getenv("SLACK_TOKEN")
)

Arguments

Details

If a character is passed to f then it will evaluate internally to a function.

Value

function

Author(s)

Jonathan Sidi (aut)

See Also

slackr_msg()

Examples

## Not run: 
ctl <- c(4.17, 5.58, 5.18, 6.11, 4.50, 4.61, 5.17, 4.53, 5.33, 5.14)
trt <- c(4.81, 4.17, 4.41, 3.59, 5.87, 3.83, 6.03, 4.89, 4.32, 4.69)
group <- gl(2, 10, 20, labels = c("Ctl", "Trt"))
weight <- c(ctl, trt)

# pass a message to Slack channel 'general'
register_onexit(lm, "bazinga!", channel = "#general")

lm.D9 <- slack_lm(weight ~ group)

# test that output keeps inheritance
summary(lm.D9)

# pass a message to Slack channel 'general' with a header message to begin output
register_onexit(
  lm,
  "bazinga!",
  channel = "#general",
  header_msg = "This is a message to begin"
)

lm.D9 <- slack_lm(weight ~ group)

# onexit with an expression that calls lm.plot
register_onexit(
  lm,
  {
    par(mfrow = c(2, 2), oma = c(0, 0, 2, 0))
    plot(z)
  },
  channel = "#general",
  header_msg = "This is a plot just for this output",
  use_device = TRUE
)

lm.D9 <- slack_lm(weight ~ group)

# clean up slack channel from examples
slackr_delete(count = 6, channel = "#general")

## End(Not run)

Output R expressions to a Slack channel/user

Description

Takes an expr, evaluates it and sends the output to a Slack chat destination. Useful for logging, messaging on long compute tasks or general information sharing.

Usage

slackr(
  ...,
  channel = Sys.getenv("SLACK_CHANNEL"),
  username = Sys.getenv("SLACK_USERNAME"),
  icon_emoji = Sys.getenv("SLACK_ICON_EMOJI"),
  token = Sys.getenv("SLACK_TOKEN"),
  thread_ts = NULL,
  reply_broadcast = FALSE
)

Arguments

Details

By default, everything but expr will be looked for in a "SLACK_" environment variable. You can override or just specify these values directly instead, but it's probably better to call slackr_setup() first.

Value

the response (invisibly)

Note

You need a https://www.slack.com account and will also need to set up an API token https://api.slack.com/

See Also

slackr_setup(), slackr_bot(), slackr_dev(), slackr_save(), slackr_upload()

Examples

## Not run: 
slackr_setup()
slackr("iris info", head(iris), str(iris))

## End(Not run)

Send result of R expressions to a Slack channel via webhook API

Description

Takes an expr, evaluates it and sends the output to a Slack chat destination via the webhook API. Useful for logging, messaging on long compute tasks or general information sharing.

Usage

slackr_bot(
  ...,
  incoming_webhook_url = Sys.getenv("SLACK_INCOMING_WEBHOOK_URL")
)

Arguments

Details

By default, everything but expr will be looked for in a "SLACK_" environment variable. You can override or just specify these values directly instead, but it's probably better to call slackr_setup() first.

Webhook URLs

Webhook URLs look like:

• ⁠https://hooks.slack.com/services/XXXXX/XXXXX/XXXXX⁠

OLD STYLE WEBHOOKS ARE NO LONGER SUPPORTED

Note

You need a https://www.slack.com account and will also need to setup an incoming webhook: https://api.slack.com/. Old style webhooks are no longer supported.

See Also

slackr_setup(), slackr(), slackr_dev(), slackr_save(), slackr_upload()

Examples

## Not run: 
slackr_setup()
slackr_bot("iris info", head(iris), str(iris))

# or directly
slackr_bot(
  "Test message",
  incoming_webhook_url = "https://hooks.slack.com/services/XXXXX/XXXXX/XXXXX"
)

## End(Not run)

Get a data frame of Slack channels

Description

Get a data frame of Slack channels

Usage

slackr_channels(token = Sys.getenv("SLACK_TOKEN"), exclude_archived = TRUE)

Arguments

Value

A data.frame of channels

Translate vector of channel names to channel IDs for API

Description

Given a vector of one or more channel names, retrieve list of active channels and try to replace channels that begin with "⁠#⁠" or "@" with the channel ID for that channel.

Usage

slackr_chtrans(channels, token = Sys.getenv("SLACK_TOKEN"))

Arguments

Value

character vector - original channel list with ⁠#⁠ or @ channels replaced with ID's.

Author(s)

Quinn Weber (ctb), Bob Rudis (aut)

Send a data frame to Slack as a CSV

Description

slackr_csv simplifies the process of sending a data frame to Slack as a CSV file. It is highly recommended to leave the filename argument as the default (tempfile), as changing it will persist a csv file in your working directory.

Usage

slackr_csv(
  data,
  filename = tempfile(fileext = ".csv"),
  title = NULL,
  initial_comment = NULL,
  channels = Sys.getenv("SLACK_CHANNEL"),
  token = Sys.getenv("SLACK_TOKEN"),
  thread_ts = NULL,
  ...
)

Arguments

Value

httr response object from POST call (invisibly)

httr response object from POST call (invisibly)

Author(s)

Matt Kaye (aut)

See Also

slackr_upload()

slackr_delete

Description

Deletes the specified number of messages from the channel

Usage

slackr_delete(
  count,
  channel = Sys.getenv("SLACK_CHANNEL"),
  token = Sys.getenv("SLACK_TOKEN")
)

Arguments

Send the graphics contents of the current device to a Slack channel

Description

slackr_dev sends the graphics contents of the current device to the specified Slack channel.

Usage

slackr_dev(
  channels = Sys.getenv("SLACK_CHANNEL"),
  token = Sys.getenv("SLACK_TOKEN"),
  file = "plot",
  initial_comment = NULL,
  title = NULL,
  thread_ts = NULL
)

Arguments

Value

httr response object from POST call

Author(s)

Konrad Karczewski (ctb), Bob Rudis (aut)

References

https://github.com/mrkaye97/slackr/pull/12/files

See Also

slackr_setup(), slackr_save(), slackr_upload()

Examples

## Not run: 
slackr_setup()

# base
library(maps)
map("usa")
slackr_dev("#results", file = "map")

# base
barplot(VADeaths)
slackr_dev("@jayjacobs")

## End(Not run)

Reads history of a channel.

Description

Returns a dataframe of post history in a channel.

Usage

slackr_history(
  message_count = 100,
  channel = Sys.getenv("SLACK_CHANNEL"),
  token = Sys.getenv("SLACK_TOKEN"),
  posted_to_time = as.numeric(Sys.time()),
  duration = NULL,
  posted_from_time = 0,
  paginate = FALSE,
  inclusive = TRUE
)

Arguments

Value

A tibble with message metadata

Scopes

You need one or more of these scopes enabled in your slack app: * channels:history * groups:history * im:history * mpim:history

References

https://api.slack.com/methods/conversations.history

Get a data frame of Slack IM ids

Description

Get a data frame of Slack IM ids

Usage

slackr_ims(token = Sys.getenv("SLACK_TOKEN"))

Arguments

Value

data.frame of im ids and user names

Author(s)

Quinn Weber (aut), Bob Rudis (ctb)

References

https://github.com/mrkaye97/slackr/pull/13

Sends a message to a slack channel.

Description

Sends a message to a slack channel.

Usage

slackr_msg(
  txt = "",
  channel = Sys.getenv("SLACK_CHANNEL"),
  username = Sys.getenv("SLACK_USERNAME"),
  icon_emoji = Sys.getenv("SLACK_ICON_EMOJI"),
  token = Sys.getenv("SLACK_TOKEN"),
  thread_ts = NULL,
  reply_broadcast = FALSE,
  ...
)

Arguments

Value

the response (invisibly)

Note

You need a https://www.slack.com account and will also need to setup an API token https://api.slack.com/ Also, you can pass in add_user=TRUE as part of the ... parameters and the Slack API will post the message as your logged-in user account (this will override anything set in username)

See Also

slackr_setup(), slackr_bot(), slackr_dev(), slackr_save(), slackr_upload()

Examples

## Not run: 
slackr_setup()
slackr_msg("Hi")

## End(Not run)

Save R objects to an RData file on Slack

Description

slackr_save enables you upload R objects (as an R data file) to Slack and (optionally) post them to one or more channels (if channels is not empty).

Usage

slackr_save(
  ...,
  channels = Sys.getenv("SLACK_CHANNEL"),
  file = "slackr",
  token = Sys.getenv("SLACK_TOKEN"),
  initial_comment = NULL,
  title = NULL,
  thread_ts = NULL
)

Arguments

Value

httr response object from POST call

See Also

slackr_setup(), slackr_dev(), slackr_upload()

Examples

## Not run: 
slackr_setup()
slackr_save(mtcars, channels = "#slackr", file = "mtcars")

## End(Not run)

Setup environment variables for Slack API access

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 = "",
  token = "",
  config_file = "~/.slackr",
  echo = FALSE,
  cache_dir = ""
)

Arguments

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:

 token: SLACK_TOKEN
 channel: #general
 username: slackr
 incoming_webhook_url: https://hooks.slack.com/services/XXXXX/XXXXX/XXXXX

Value

"Successfully connected to Slack"

Note

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

See Also

slackr(), slackr_dev(), slackr_save(), 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)

Unset env vars created by slackr_setup()

Description

Unset env vars created by slackr_setup()

Usage

slackr_teardown()

Value

TRUE if successful (invisibly)

See Also

slackr_setup()

Examples

## Not run: 
slackr_teardown()

## End(Not run)

Post a tex output to a Slack channel

Description

Unlike the slackr_dev() function, this one takes a tex object, eliminating the need write to pdf and convert to png to pass to slack.

Usage

slackr_tex(
  obj,
  channels = Sys.getenv("SLACK_CHANNEL"),
  token = Sys.getenv("SLACK_TOKEN"),
  ext = "png",
  path = NULL,
  title = NULL,
  initial_comment = NULL,
  thread_ts = NULL,
  ...
)

Arguments

Details

Please make sure texPreview package is installed before running this function. For TeX setup refer to the Setup notes on LaTeX.

Value

httr response object (invisibly)

Note

You need to setup a full API token (i.e. not a webhook & not OAuth) for this to work Also, you can pass in add_user=TRUE as part of the ... parameters and the Slack API will post the message as your logged-in user account (this will override anything set in username)

Author(s)

Jonathan Sidi (aut)

See Also

texPreview::tex_preview()

Send a file to Slack

Description

slackr_upload enables you upload files to Slack and (optionally) post them to one or more channels (if channels is not empty).

Usage

slackr_upload(
  filename,
  title = NULL,
  initial_comment = NULL,
  channels = Sys.getenv("SLACK_CHANNEL"),
  token = Sys.getenv("SLACK_TOKEN"),
  thread_ts = NULL
)

Arguments

Value

httr response object from POST call (invisibly)

httr response object from POST call (invisibly)

Author(s)

Quinn Weber (ctb), Bob Rudis (aut)

References

https://github.com/mrkaye97/slackr/pull/15/files

See Also

slackr_setup(), slackr_dev(), slackr_save()

Get a data frame of Slack users

Description

Get a data frame of Slack users

Usage

slackr_users(token = Sys.getenv("SLACK_TOKEN"))

Arguments

Value

data.frame of users

Check for token-parameter mismatches

Description

Check for token-parameter mismatches

Usage

warn_for_args(token, ...)

Arguments

Value

No return value. Called for side effects

Calls the slack API with pagination using cursors.

Description

This loops over fun, extracts the next_cursor from the API response, and injects this into the next loop. At the completion of each loop, the function convert_response_to_tibble() is run with extract as and argument. The results are combined with dplyr::bind_rows()

Usage

with_pagination(fun, extract)

Arguments

Value

A tibble

See Also

call_slack_api