Slackeonnier - send data notifications with color and plot to Slack by 🕊️.
🔕 Mute redundant quetions from your boss
Complete ideation and implementation please check out medium article.
# Depeche mode
devtools::install_github("HongYanHuang/slackeonnier")
# Classic - coming soon
# install.packages("slackeonnier")# load library
library(slackeonnier)## setup slackeonnier
slackeonnier_setup(upload_api_token = "your slack upload token",
upload_image_channel = "#your-storage-channel",
incoming_webhook_url = "your incoming webhook",
sent_channel = "#general",
username = " ")## upload your plot, will return a private slack-url for attach
plot_url <- plot_upload(plot = your.plot)
## formating text, color, plot
atc <- attachment_format(former_text = your_text,
status_color = color_hex,
image_url = plot_url)## sent by slackeonnier
slackeonnier_sent(atc)run example script
Recommended in setting environment argument for slackeonnier; otherwise you must provide in every function needed.
| Name | Format | Require | Description |
|---|---|---|---|
| upload_api_token | string | Yes | file:upload token |
| upload_image_channel | string | Yes | alternative channel for uploading plot, default #random |
| incoming_webhook_url | string | Yes | incoming webhook for posting notification |
| sent_channel | string | No | will post notification to this channel, default #general |
| username | string | No | name of slack App, default slackeonnier |
Upload your ggplot object to slack and return a private url for upcoming attach in message.
| Name | Format | Require | Description |
|---|---|---|---|
| plot | ggplot object | Yes | ggplot object to upload |
| upload_api_token | string | Yes | use slackeonnier_setup() |
| upload_image_channel | string | Yes | use slackeonnier_setup() |
Plot + Text + Color formatting as an attachment object.
| Name | Format | Require | Description |
|---|---|---|---|
| former_text | string | Yes | text in message |
| status_color | string | Yes | Hex code |
| image_url | string | No | your url from plot_upload() |
sent attachment to slack channel
| Name | Format | Require | Description |
|---|---|---|---|
| attachment | json | Yes | text in message |
| webhook | string | Yes | use slackeonnier_setup() |
| channel | string | No | use slackeonnier_setup(), default #general |
| username | string | No | use slackeonnier_setup(), default slackeonnier |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent