Package 'promoutils' reference manual

Title:	Utilities for Promoting rOpenSci
Description:	Utility functions and workflows for promoting community events and community members on rOpenSci website and social media.
Authors:	Steffi LaZerte [aut, cre] (ORCID: <https://orcid.org/0000-0002-7690-8360>), Yanina Bellini Saibene [ctb] (ORCID: <https://orcid.org/0000-0002-4522-7466>)
Maintainer:	Steffi LaZerte <[email protected]>
License:	GPL (>= 3)
Version:	0.7.1
Built:	2026-09-29 21:05:37 UTC
Source:	https://github.com/ropensci-org/promoutils

Create a cached version of the GH api calls

Description

Create a cached version of the GH api calls

Usage

.gh_cache(..., .token = key("github"), .max_rate = NULL)
.gh_cache(..., .token = key("github"), .max_rate = NULL)

Arguments

...

Arguments passed on to gh::gh

endpoint

GitHub API endpoint. Must be one of the following forms:

⁠METHOD path⁠, e.g. GET /rate_limit,
path, e.g. ⁠/rate_limit⁠,
⁠METHOD url⁠, e.g. ⁠GET https://api.github.com/rate_limit⁠,
url, e.g. ⁠https://api.github.com/rate_limit⁠.

If the method is not supplied, will use .method, which defaults to "GET".

per_page,.per_page

Number of items to return per page. If omitted, will be substituted by max(.limit, 100) if .limit is set, otherwise determined by the API (never greater than 100).

.destfile

Path to write response to disk. If NULL (default), response will be processed and returned as an object. If path is given, response will be written to disk in the form sent. gh writes the response to a temporary file, and renames that file to .destfile after the request was successful. The name of the temporary file is created by adding a ⁠-<random>.gh-tmp⁠ suffix to it, where ⁠<random>⁠ is an ASCII string with random characters. gh removes the temporary file on error.

.overwrite

If .destfile is provided, whether to overwrite an existing file. Defaults to FALSE. If an error happens the original file is kept.

.api_url

Github API url (default: https://api.github.com). Used if endpoint just contains a path. Defaults to GITHUB_API_URL environment variable if set.

.method

HTTP method to use if not explicitly supplied in the endpoint.

.limit

Number of records to return. This can be used instead of manual pagination. By default it is NULL, which means that the defaults of the GitHub API are used. You can set it to a number to request more (or less) records, and also to Inf to request all records. Note, that if you request many records, then multiple GitHub API calls are used to get them, and this can take a potentially long time.

.accept

The value of the Accept HTTP header. Defaults to "application/vnd.github.v3+json" . If Accept is given in .send_headers, then that will be used. This parameter can be used to provide a custom media type, in order to access a preview feature of the API.

.send_headers

Named character vector of header field values (except Authorization, which is handled via .token). This can be used to override or augment the default User-Agent header: "https://github.com/r-lib/gh".

.progress

Whether to show a progress indicator for calls that need more than one HTTP request.

.params

Additional list of parameters to append to .... It is easier to use this than ... if you have your parameters in a list already.

.max_wait

Maximum number of seconds to wait if rate limited. Defaults to 10 minutes.

.token

Authentication token. Defaults to gh_token().

.max_rate

Maximum request rate in requests per second. Set this to automatically throttle requests.

Details

memoise::memoise(gh::gh)

List of IDs for Buffer channels: Bluesky, Mastodon, and LinkedIn

Description

List of IDs for Buffer channels: Bluesky, Mastodon, and LinkedIn

Usage

buff_channels
buff_channels

Format

An object of class list of length 3.

Number of characters permitted by social media channels via Buffer

Description

Number of characters permitted by social media channels via Buffer

Usage

buff_nchars
buff_nchars

Format

An object of class numeric of length 3.

rOpenSci Buffer organization id

Description

rOpenSci Buffer organization id

Usage

buff_org
buff_org

Format

An object of class character of length 1.

Return Buffer channel ids

Description

Return Buffer channel ids

Usage

buffer_channels(org = promoutils::buff_org, dry_run = FALSE)
buffer_channels(org = promoutils::buff_org, dry_run = FALSE)

Arguments

org

Character. Organizational ID to return channels for (see buffer_org()). Uses rOpenSci's by default buff_org.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

Value

Data frame with id and service (linkedin, mastodon, bluesky, etc.)

Examples


buffer_channels()

buffer_channels()

Clean up draft/scheduled testing messages

Description

Removes all testing draft and/or scheduled messages matching "^testing( scheduled)? Api again...$".

Usage

buffer_cleanup()
buffer_cleanup()

Value

Data frame with removed post ids

Examples


buffer_cleanup()

buffer_cleanup()

Return Buffer Organization account id

Description

Return Buffer Organization account id

Usage

buffer_org(fields = "id", dry_run = FALSE)
buffer_org(fields = "id", dry_run = FALSE)

Arguments

fields

Character. Information to return. Defaults to 'id'.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

Value

The organization account id on Buffer.

Examples


buffer_org()

buffer_org()

Return a list of Buffer posts

Description

Fetches a list of posts on all channels on Buffer.

Usage

buffer_posts_list(
  status = c("scheduled", "draft"),
  fields = c("id", "channelService", "text", "createdAt", "dueAt", "status"),
  since = NULL,
  dry_run = FALSE,
  org = promoutils::buff_org
)
buffer_posts_list(
  status = c("scheduled", "draft"),
  fields = c("id", "channelService", "text", "createdAt", "dueAt", "status"),
  since = NULL,
  dry_run = FALSE,
  org = promoutils::buff_org
)

Arguments

status

Character vector. Status of posts to return. Defaults to "scheduled" and "draft", set to "sent" to return all posted messages. Options are "draft", "error", "needs_approal","scheduled", "sending", "sent".

fields

Character vector. Information to return. Become the columns in

since

Character. Only return posts scheduled/sent after this date. the data frame.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

org

Character. Buffer ID of the organization to return channels from. Defaults to rOpenSci's ID.

Value

Data frame of posts

References

Post status: https://developers.buffer.com/reference.html#type/PostStatus Posts: https://developers.buffer.com/reference.html#field-posts Fields: https://developers.buffer.com/reference.html#type/Post

Examples


buffer_posts_list()
buffer_posts_list(status = "error")
buffer_posts_list(status = "sent")

buffer_posts_list()
buffer_posts_list(status = "error")
buffer_posts_list(status = "sent")

Remove posts on Buffer

Description

Remove posts on Buffer

Usage

buffer_posts_remove(id, dry_run = FALSE)
buffer_posts_remove(id, dry_run = FALSE)

Arguments

id

Character vector. Id(s) of the post(s) to be removed.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

Value

Data frame of removed posts

Examples


p <- buffer_posts_write("testing Api again...", "now", channels = "mastodon")
buffer_posts_remove(p$id)

p <- buffer_posts_write("testing Api again...", "now", channels = "mastodon")
buffer_posts_remove(p$id)

Create a social media post on Buffer

Description

Create a social media post on Buffer

Usage

buffer_posts_write(
  body,
  when,
  tz = NULL,
  channels = c("mastodon", "linkedin", "bluesky"),
  draft = TRUE,
  dry_run = FALSE,
  open_browser = interactive(),
  handles = NULL,
  ...
)
buffer_posts_write(
  body,
  when,
  tz = NULL,
  channels = c("mastodon", "linkedin", "bluesky"),
  draft = TRUE,
  dry_run = FALSE,
  open_browser = interactive(),
  handles = NULL,
  ...
)

Arguments

body

Character vector. Text to use as the body of the post. Can be a vector the same length as channels to use different text for each channel.

when

Character/Date time. Either "now" to post immediately or create a draft post for immediate posting, or a Date/time to specify when the post should be scheduled.

tz

Character. The OlsonNames() timezone to use for when if it is a character string (if when is a date/time tz is ignored). Default (NULL) uses system timezone.

channels

Character vector. Where to post? Options are "mastodon", "bluesky", and/or "linkedin".

draft

Logical. Whether this post should be a draft.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

open_browser

Logical. Whether to open the issue in the browser.

handles

List. Provide a list of handles (alternative to ...). Use the format of list(id1 = c(mastodon = "handle", ...), id2 = c(mastodon = "handle"), ...), where id1 is used in the body as {id1} and the names (mastodon, etc.) must match the channels.

...

Handles to add to the body (alternative to handles argument). Should be id = c(mastodon = "handle", bluesky = "handle", linkedin = "handle") where id is used in the body as {id} and the names (mastodon, bluesky, linkedin) must match the channels.

Value

Data frame of post ids

Examples


p <- buffer_posts_write("testing Api again...", when = "now") # Create draft
buffer_posts_remove(p$id)
p <- buffer_posts_write("testing Api again...", when = "2027-01-01 10:00") # Create schedueld draft
buffer_posts_remove(p$id)

# Create draft using appropriate handles
p <- buffer_posts_write(
  "testing Api again... {steffi} and {yani}",
  when = "now",
  steffi = c(
    "mastodon" = "@[email protected]",
    "bluesky" = "@steffilazerte.bsky.social",
    "linkedin" = "Steffi LaZerte"
  ),
  yani = c(
    "mastodon" = "@[email protected]",
    "bluesky" = "@yabellini.bsky.social",
    "linkedin" = "Yanina Bellini Saibene"
  )
)

buffer_posts_remove(p$id)

p <- buffer_posts_write(
  paste0(rep("testing Api again...\n\n", 20), collapse = ""),
  when = "now"
)

p <- buffer_posts_write("testing Api again...", when = "now") # Create draft
buffer_posts_remove(p$id)
p <- buffer_posts_write("testing Api again...", when = "2027-01-01 10:00") # Create schedueld draft
buffer_posts_remove(p$id)

# Create draft using appropriate handles
p <- buffer_posts_write(
  "testing Api again... {steffi} and {yani}",
  when = "now",
  steffi = c(
    "mastodon" = "@[email protected]",
    "bluesky" = "@steffilazerte.bsky.social",
    "linkedin" = "Steffi LaZerte"
  ),
  yani = c(
    "mastodon" = "@[email protected]",
    "bluesky" = "@yabellini.bsky.social",
    "linkedin" = "Yanina Bellini Saibene"
  )
)

buffer_posts_remove(p$id)

p <- buffer_posts_write(
  paste0(rep("testing Api again...\n\n", 20), collapse = ""),
  when = "now"
)

Arrange by platform

Description

Arranges data in long by platform (linkedin and mastodon).

Usage

by_platform(df)
by_platform(df)

Arguments

df

Data frame. Formatted data including social media handles.

Value

Data frame arranged by platform on which to advertise.

Examples


u <- uc_fetch() |>
  uc_fmt("2025-01-01") |>
  uc_handles() |>
  by_platform()

u <- uc_fetch() |>
  uc_fmt("2025-01-01") |>
  uc_handles() |>
  by_platform()

Cache folder to store data

Description

Where the cache will be or is for specific types of data cached by promoutils.

Usage

cache_dir(type)
cache_dir(type)

Arguments

type

Character. Data type to cache.

Value

Character file path

Examples

cache_dir(type = "matomo")
cache_dir(type = "help-wanted")
cache_dir(type = "matomo")
cache_dir(type = "help-wanted")

Create draft message for checking in with Cohosts

Description

The week before, prepare the slides and coworking document, then use this draft text to invite the cohost(s) to review via Slack or Email.

Usage

cw_checkin(which = "next", names = NULL, print = FALSE)
cw_checkin(which = "next", names = NULL, print = FALSE)

Arguments

which

Character/Date. "next" to fetch details on the next coworking session, "last" to fetch details on the last scheduled (in future) coworking session, or a Date fetch details for a specific coworking session.

names

Character. Names of cohost if overriding those in the event listing.

print

Logical. Whether to simply print the text to console instead of copying to the clipboard.

Create draft message for checking in with Cohosts about the Event review

Description

When an event has been drafted use this draft text to invite the cohost(s) to review via Slack or Email.

Usage

cw_checkin_event(which = "next", names = NULL, print = FALSE)
cw_checkin_event(which = "next", names = NULL, print = FALSE)

Arguments

which

names

Character. Names of cohost if overriding those in the event listing.

print

Logical. Whether to print the copied text to the console.

Examples


cw_checkin_event("2026-04-07")

cw_checkin_event("2026-04-07")

Fetch details about coworking sessions

Description

Fetch details about coworking sessions

Usage

cw_details(which = "next")
cw_details(which = "next")

Arguments

which

Value

Data frame with coworking event details

Examples


cw_details()
# cw_details("2023-11") # Only works for events in the future

cw_details()
# cw_details("2023-11") # Only works for events in the future

Get link to Coworking docs

Description

Creates the coworking doc if it doesn't exist and returns a link either way. Optionally creates PR adds link to event page.

Usage

cw_docs_link(which = "next", open_sites = TRUE, add = FALSE)
cw_docs_link(which = "next", open_sites = TRUE, add = FALSE)

Arguments

which

open_sites

Logical. Open websites with relevant details?

add

Logical. Whether to initialize a PR and add the link to the events file.

Value

Google Docs link

Create a draft event for coworking

Description

Creates a draft coworking event for the roweb3 website. All details pulled from the coworking todo list issue in rosadmin/comms. See cw_issue().

Usage

cw_event(date, dry_run = FALSE)
cw_event(date, dry_run = FALSE)

Arguments

date

Character/Date. Date of the coworking event to create

dry_run

Logical. Whether to really create the event or just return the text.

Create Coworking To-Dos

Description

Create a GitHub issue in a repository listing the Coworking ToDos. If no date or timezone, picks the next appropriate date (first Tuesday of the month following an existing coworking issue) and next appropriate timezone (cycling through America, Europe, and Australia) automatically.

Usage

cw_issue(
  date = NULL,
  tz = NULL,
  theme = "XXXX",
  cohost = "XXXX",
  repo = "rosadmin/comms",
  dry_run = FALSE
)
cw_issue(
  date = NULL,
  tz = NULL,
  theme = "XXXX",
  cohost = "XXXX",
  repo = "rosadmin/comms",
  dry_run = FALSE
)

Arguments

date

Character. Date of next event (if NULL picks next first Tuesday).

tz

Character. Timezone of next event (if NULL picks next in order).

theme

Character. Name of theme, if unknown, uses XXXX placeholder

cohost

Character. Name of cohost, if unknown, uses XXXX placeholder

repo

Character. GitHub repository including owner (e.g., rosadmin/comms)

dry_run

Logical. Whether to really create the issue or just return the text.

Value

Nothing

Examples


cw_issue(dry_run = TRUE)

cw_issue(dry_run = TRUE)

Create a draft post for coworking

Description

Creates draft posts for Bluesky, Mastodon, and LinkedIn (through Buffer) and Slack (through Slack API, and text for copy/paste to other Slack spaces).

Usage

cw_posts(
  date,
  host = list(mastodon = "@[email protected]", slack = "UNRAUCMTK", linkedin =
    "Steffi LaZerte", bluesky = "@steffilazerte.bsky.social"),
  cohost,
  posters_tz = Sys.timezone(),
  test_run = FALSE,
  dry_run = FALSE,
  print = TRUE,
  branch = NULL
)
cw_posts(
  date,
  host = list(mastodon = "@[email protected]", slack = "UNRAUCMTK", linkedin =
    "Steffi LaZerte", bluesky = "@steffilazerte.bsky.social"),
  cohost,
  posters_tz = Sys.timezone(),
  test_run = FALSE,
  dry_run = FALSE,
  print = TRUE,
  branch = NULL
)

Arguments

date

Character/Date. Date of the coworking event (local)

host

List. Named list of social media handles for the host, must include "mastodon", "bluesky", "linkedin", and "slack". Where there is no handle, use the host's full name.

cohost

List. Named list of social media handles for the cohost. must include "mastodon", "bluesky", "linkedin", and "slack". Where there is no handle, use the cohost's full name.

posters_tz

Character. Timezone of poster. Required for getting the time at which to post Slack messages as these are posted in the local timezone.

test_run

Logical. Whether to do a test run (i.e. post to a test area).

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

print

Logical. Whether to simply print the text to console instead of copying to the clipboard.

branch

Character. Branch name if not on main.

Examples

cw_posts(
  "2023-07-04",
  cohost = list(
    "mastodon" = "@[email protected]",
    "bluesky" = "@[email protected]",
    "linkedin" = "Cohost",
    "slack" = "UXXXXXXX"
  ),
  dry_run = TRUE
)

## Not run: 
  cw_posts(
    "2023-07-04",
     cohost = list(
      "mastodon" = "@[email protected]",
      "bluesky" = "@[email protected]",
      "linkedin" = "Cohost",
      slack = "UXXXXXXX"
    )
  )

## End(Not run)
cw_posts(
  "2023-07-04",
  cohost = list(
    "mastodon" = "@[email protected]",
    "bluesky" = "@[email protected]",
    "linkedin" = "Cohost",
    "slack" = "UXXXXXXX"
  ),
  dry_run = TRUE
)

## Not run: 
  cw_posts(
    "2023-07-04",
     cohost = list(
      "mastodon" = "@[email protected]",
      "bluesky" = "@[email protected]",
      "linkedin" = "Cohost",
      slack = "UXXXXXXX"
    )
  )

## End(Not run)

Schedule 1-hour before messages on rOpenSci Slack

Description

Will only work if running between the time that the 1-week message was posted and the start of the coworking.

Usage

cw_slack_hour_msg(
  user = "UNRAUCMTK",
  test_run = FALSE,
  dry_run = FALSE,
  print = FALSE,
  call = rlang::caller_env()
)
cw_slack_hour_msg(
  user = "UNRAUCMTK",
  test_run = FALSE,
  dry_run = FALSE,
  print = FALSE,
  call = rlang::caller_env()
)

Arguments

user

Character. Slack user id.

test_run

Logical. Whether to run a test of this message posting to the test channel.

dry_run

Logical. Whether to do a dry run, print the message only.

print

Logical. Whether to simply print the text to console instead of copying to the clipboard.

call

Environment. Parent environment for messaging.

Value

Nothing

Examples


cw_slack_hour_msg(test_run = TRUE)
cw_slack_hour_msg(dry_run = TRUE)

cw_slack_hour_msg(test_run = TRUE)
cw_slack_hour_msg(dry_run = TRUE)

Open and fetch link to coworking slides

Description

Open and fetch link to coworking slides

Usage

cw_slides_link(open_site = TRUE)
cw_slides_link(open_site = TRUE)

Arguments

open_site

Logical. Open slides in browser?

Value

Link to slides

Create a text based todo list for Coworking tasks

Description

This list can be copy/pasted into todo software to keep track of dated reminders for arranging coworking events.

Usage

cw_todos_list(start = NULL, end = NULL)
cw_todos_list(start = NULL, end = NULL)

Arguments

start

Start date for coworking tasks. NULL by default to do Jan-Dec for the next year.

end

End date for coworking tasks. NULL by default to do Jan-Dec for the next year.

Value

Text TO-DO list

Examples

cw_todos_list()
cw_todos_list()

Dictionary for help-wanted

Description

Creates a data frame dictionary of different versions of wording to use in help-wanted posts depending on the language of the post.

Usage

dict_helpwanted()
dict_helpwanted()

Value

Data frame.

Examples

dict_helpwanted()
dict_helpwanted()

Dictionary for usecases

Description

Creates a data frame dictionary of different versions of wording to use in usecase posts depending on the language of the post.

Usage

dict_usecases()
dict_usecases()

Value

Data frame.

Examples

dict_usecases()
dict_usecases()

Close a GH issue

Description

Closes a GH issue by number, repository and owner.

Usage

gh_issue_close(n, owner, repo, dry_run = FALSE)
gh_issue_close(n, owner, repo, dry_run = FALSE)

Arguments

n

Numeric. Issue number to close.

owner

Character. GitHub username or organization owner of the repository.

repo

Character. Repository in which to create issue.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

Examples

## Not run: 
  # Closes the first issue in the "myrop" repository of "myhandle" on GitHub
  gh_issue_close(1, "myhandle", "myrepo")

## End(Not run)
## Not run: 
  # Closes the first issue in the "myrop" repository of "myhandle" on GitHub
  gh_issue_close(1, "myhandle", "myrepo")

## End(Not run)

Fetch issues from a GH repository

Description

Fetches issues from a GitHub repository and returns them as a list. Pass on to gh_issue_fmt() for formatting.

Usage

gh_issue_fetch(
  state = "open",
  labels = NULL,
  since = NULL,
  owner = "rosadmin",
  repo = "scheduled_socials",
  issue = NULL,
  verbose = FALSE
)
gh_issue_fetch(
  state = "open",
  labels = NULL,
  since = NULL,
  owner = "rosadmin",
  repo = "scheduled_socials",
  issue = NULL,
  verbose = FALSE
)

Arguments

state

Character. Which issues to fetch: "open", "closed", "all"

labels

Character vector. Fetch only issues with these labels. (Optional)

since

Character/Date/datetime. Fetch only issues since this date/time. (Optional)

owner

Character. Owner of the repository

repo

Character. Name of the repository (name of the package)

issue

Numeric. Specific Issue number to fetch.

verbose

Logical. Show extra informative messages.

Value

List of issues

Examples

i <- gh_issue_fetch(owner = "ropensci", repo = "weathercan")
i <- gh_issue_fetch(owner = "ropensci", repo = "weathercan", verbose = TRUE)
i <- gh_issue_fetch(owner = "ropensci", repo = "weathercan")
i <- gh_issue_fetch(owner = "ropensci", repo = "weathercan", verbose = TRUE)

Format issues list from GH

Description

Format issues list from GH

Usage

gh_issue_fmt(
  i,
  which = c("title", "number", "body", "labels", "url", "created", "updated",
    "gh_user_issue")
)
gh_issue_fmt(
  i,
  which = c("title", "number", "body", "labels", "url", "created", "updated",
    "gh_user_issue")
)

Arguments

i

List of issues from gh_issue_fetch()

which

Which fields to include

Value

Issues formated as a data frame

Examples

i <- gh_issue_fetch(owner = "ropensci", repo = "weathercan")
i <- gh_issue_fmt(i, which = "title")
i
i <- gh_issue_fetch(owner = "ropensci", repo = "weathercan")
i <- gh_issue_fmt(i, which = "title")
i

Create a GH issues post

Description

Opens an issue on Github with title, body and labels.

Usage

gh_issue_post(
  title,
  body,
  labels,
  owner,
  repo,
  avoid_dups = TRUE,
  dry_run = FALSE,
  open_browser = TRUE
)
gh_issue_post(
  title,
  body,
  labels,
  owner,
  repo,
  avoid_dups = TRUE,
  dry_run = FALSE,
  open_browser = TRUE
)

Arguments

title

Character. Title of the issue.

body

Character. Body text of the issue.

labels

Character vector. Vector of labels to assign.

owner

Character. GitHub username or organization owner of the repository.

repo

Character. Repository in which to create issue.

avoid_dups

Logical. If TRUE (default), avoids posting duplicate issues.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

open_browser

Logical. Whether to open the issue in the browser.

Examples

gh_issue_post(
  title = "My issue",
  body = "Body of the issue",
  labels = "help-wanted",
  owner = "ropensci",
  repo = "weathercan",
  dry_run = TRUE
)
gh_issue_post(
  title = "My issue",
  body = "Body of the issue",
  labels = "help-wanted",
  owner = "ropensci",
  repo = "weathercan",
  dry_run = TRUE
)

Fetch help wanted issues

Description

Fetch help wanted issues

Usage

help_fetch(
  min_date = NULL,
  json = "/repos/rosadmin/help-wanted/contents/issues.json"
)
help_fetch(
  min_date = NULL,
  json = "/repos/rosadmin/help-wanted/contents/issues.json"
)

Arguments

min_date

Character/Date. Earliest date a help-wanted label was added to an issue to be included.

json

Character. Location of the issues.json file to use.

Value

Data frame of help wanted issues

Examples


h <- help_fetch()

h <- help_fetch()

Get a data frame of social media handles for help-wanted issues

Description

Get a data frame of social media handles for help-wanted issues

Usage

help_handles(help)
help_handles(help)

Arguments

help

Data frame of help wanted issues.

Value

Data frame of social media handles associated with help

Examples


help_fetch() |>
  help_handles()

help_fetch() |>
  help_handles()

Create help-wanted post

Description

Create help-wanted post

Usage

help_post(help, skip = NULL, date_time = NULL, dry_run = FALSE)
help_post(help, skip = NULL, date_time = NULL, dry_run = FALSE)

Arguments

help

Data frame. Formatted help-wanted issues including social media handles.

skip

Numeric vector. The help wanted issues to skip creating a post for.

date_time

Character/Date. When to post. Defaults to next Thursday if NULL.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

Value

Copies commands to clipboard, optionally prints if (print = TRUE).

Examples


h <- help_fetch()

help_preview(h)
# Review and note issues to skip

help_post(h, skip = c(1:6), dry_run = TRUE)  # For non-interactive examples

h <- help_fetch()

help_preview(h)
# Review and note issues to skip

help_post(h, skip = c(1:6), dry_run = TRUE)  # For non-interactive examples

Prepare help-wanted posts

Description

Prepare posts and preview

Usage

help_preview(help)
help_preview(help)

Arguments

help

Data frame. Formatted help-wanted issues including social media handles.

Value

Copies commands to clipboard, optionally prints if (print = TRUE).

Examples


h <- help_fetch()
help_preview(h)

h <- help_fetch()
help_preview(h)

Create help wanted JSON file

Description

Function created for rosadmin/help-wanted. Fetches package repos with issues labelled help-wanted (and variants). Saves output to issues.json for use by helpwanted workflows including https://ropensci.org/help-wanted.

Usage

hw_issues(
  min_date = Sys.Date() - lubridate::years(2),
  throttle = 10/60,
  path = "issues.json",
  verbose = TRUE
)
hw_issues(
  min_date = Sys.Date() - lubridate::years(2),
  throttle = 10/60,
  path = "issues.json",
  verbose = TRUE
)

Arguments

min_date

Date. Fetch issues since this data.

throttle

Numeric. Maximum requests per second. Default throttled to 10 requests per minute which is the max rate for unauthenticated GitHub Pats (i.e. on GH actions).

path

Character. Filename/path to save json of issues to.

verbose

Logical. Show extra informative messages.

Value

Creates/updates issues json list at path

Examples


hw_issues()

hw_issues()

Key status of credentials

Description

Check to see if you have set up all the keys required by promoutils.

Usage

keys_check()
keys_check()

Value

Message informing of status

Examples

keys_check()
keys_check()

Set keys required for promoutils API access

Description

This function guides uses through the finding and setting tokens so that promoutils can find them.

Usage

keys_set(type = NULL)
keys_set(type = NULL)

Arguments

type

Character Vector. Keys/tokens to set ("slack", "matomo", "linkedin", "github").

Value

Nothing, side effect of setting token credentials in the keyring or via gitcreds::gitcres_set() for GitHub tokens.

Authorize rOpenSci client with LinkedIn

Description

This authorizes the rOpenSci client with your credentials (and you must be part of the rOpenSci organization as an admin). Make sure to take note of the 'refresh_token' as that is what you'll add to your .Renviron file for local work, or the GitHub secrets for the comms/scheduled_socials workflow.

Usage

li_auth()
li_auth()

Details

This function authorizes with a redirect url of "http://localhost:1444/", this must be the same as that listed in the LinkedIn Developer App, https://www.linkedin.com/developers/apps.

If you retrieve a new token, you will have to put it in the .Renviron and the re-start your R session to continue

This function authorizes with the scopes:

w_member_social (default)
w_organization_social (special request)
r_organization_social (special request)
r_organization_admin (special request)

Value

httr2 authorization

References

Refresh tokens API: https://learn.microsoft.com/en-us/linkedin/shared/authentication/programmatic-refresh-tokens

Examples

## Not run: 
# Only run if you need to update the scopes or get a new token (otherwise
# you'll have to replace all your tokens)
t <- li_auth()
t$refresh_token

## End(Not run)
## Not run: 
# Only run if you need to update the scopes or get a new token (otherwise
# you'll have to replace all your tokens)
t <- li_auth()
t$refresh_token

## End(Not run)

rOpenSci LinkedIn organization URN

Description

rOpenSci LinkedIn organization URN

Usage

li_org
li_org

Format

An object of class character of length 1.

Get a list of recent posts by rOpenSci

Description

Get a list of recent posts by rOpenSci

Usage

li_posts_read(author)
li_posts_read(author)

Arguments

author

Character. LinkedIn URN id (e.g., rOpenSci's is "urn:li:organization:77132573")

Value

list of posts

References

https://learn.microsoft.com/en-us/linkedin/shared/api-guide/concepts/urns
https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/posts-api

Examples


li_posts_read(li_org)$elements[[1]]$commentary |> cat()

li_posts_read(li_org)$elements[[1]]$commentary |> cat()

Post to LinkedIn

Description

Post to LinkedIn

Usage

li_posts_write(author, body, dry_run = FALSE)
li_posts_write(author, body, dry_run = FALSE)

Arguments

author

Character. URN. Either yours (see li_urn_me() or rOpenSci's "urn:li:organization:77132573")

body

Character. The body of the post as you would like it to appear.

dry_run

Logical. TRUE to show what would be sent to the server without actually sending it.

Value

A string of the URN for the post id.

Examples

# Dry-run
id <- li_posts_write(
  author = li_org, # Post on behalf of rOpenSci
  body = "Testing out the LinkedIn API via R and httr2!",
  dry_run = TRUE)

## Not run: 
# Real post
id <- li_posts_write(
  author = li_org, # Post on behalf of rOpenSci
  body = "Testing out the LinkedIn API via R and httr2!")

## End(Not run)
# Dry-run
id <- li_posts_write(
  author = li_org, # Post on behalf of rOpenSci
  body = "Testing out the LinkedIn API via R and httr2!",
  dry_run = TRUE)

## Not run: 
# Real post
id <- li_posts_write(
  author = li_org, # Post on behalf of rOpenSci
  body = "Testing out the LinkedIn API via R and httr2!")

## End(Not run)

Fetch your personal URN number

Description

This is required to post on LinkedIn to your personal account (for rOpenSci, use the organization urn, "urn:li:organization:77132573"

Usage

li_urn_me()
li_urn_me()

Value

A string with your URN in the format of "urn:li:person:XXXX"

Examples

## Not run: 
li_urn_me()

## End(Not run)
## Not run: 
li_urn_me()

## End(Not run)

Download all Matomo historic views

Description

Downloads all views from a specific year range (2010-2024 by defautl). Views can be read with matomo_read().

Usage

matomo_all(year_range = 2010:2024, host = "https://ropensci.matomo.cloud")
matomo_all(year_range = 2010:2024, host = "https://ropensci.matomo.cloud")

Arguments

year_range

Numeric vector. Years to download views for.

host

Character. URL for the Matomo host to collect views for. Defaults to that of rOpenSci.

Details

Requires a Renviron "MATOMO_TOKEN" key representing your token for Matomo for the host you'd like to fetch data for.

Value

Nothing. Writes views to disk.

Formats and filter Matomo views to blogposts

Description

Formats and filter Matomo views to blogposts

Usage

matomo_blogposts(views)
matomo_blogposts(views)

Arguments

views

Data frame from matomo_read().

Value

Data frame of blog post views

Examples


matomo_read() |>
  matomo_blogposts()

matomo_read() |>
  matomo_blogposts()

Read Matomo views saved to disk

Description

Reads a saved set of views.

Usage

matomo_read()
matomo_read()

Value

Data frame of view data.

Examples

matomo_read()
matomo_read()

Update Matomo views

Description

Update a specific year of Matomo blog views. Defaults to current year. Views can be read with matomo_read().

Usage

matomo_update(
  year = lubridate::year(Sys.Date()),
  host = "https://ropensci.matomo.cloud"
)
matomo_update(
  year = lubridate::year(Sys.Date()),
  host = "https://ropensci.matomo.cloud"
)

Arguments

year

Numeric. Year to update

host

Character. URL for the Matomo host to collect views for. Defaults to that of rOpenSci.

Details

Requires a .Renviron "MATOMO_TOKEN" key representing your token for Matomo for the host you'd like to fetch data for.

Value

Nothing. Updates views to disk.

Find the next date

Description

Given a date and a day of the week, Given a date return the next month's first Tuesday

Usage

next_date(month, which = "Tues", n = 1, call = rlang::caller_env())
next_date(month, which = "Tues", n = 1, call = rlang::caller_env())

Arguments

month

Character/Date. The current month. Date returned is the next month.

which

Character/Numeric. Which week day to return. Either number or abbreviated English weekday.

n

Numeric. The nth week to return (i.e. the 1st Tuesday if n = 1 and which = "Tues").

call

Environment. Calling environment for appropriate messages if used within another function.

Value

A date

Examples


# Get the next first Tuesday
next_date("2023-11-01")
next_date("2023-11-30")

# Get the next 3rd Tuesday
next_date("2023-11-01", n = 3)

next_date("2027-01-31", which = "Mon", n = 1)

# Oops
## Not run: 
next_date("2023-11-01", n = 5)

## End(Not run)

# Get the next first Tuesday
next_date("2023-11-01")
next_date("2023-11-30")

# Get the next 3rd Tuesday
next_date("2023-11-01", n = 3)

next_date("2027-01-31", which = "Mon", n = 1)

# Oops
## Not run: 
next_date("2023-11-01", n = 5)

## End(Not run)

Get package author names

Description

Get package author names

Usage

pkg_authors(package, pkgs)
pkg_authors(package, pkgs)

Arguments

package

Character. Package name

pkgs

Data frame. Packages returned by pkgs_ru().

Value

Character name of maintainer

Examples

pkg_authors("weathercan", pkgs_ru())
pkg_authors("weathercan", pkgs_ru())

List of packages and details from R-Universe API

Description

List of packages and details from R-Universe API

Usage

pkgs_ru(universe = "ropensci")
pkgs_ru(universe = "ropensci")

Arguments

universe

Character. Universe to collect details from.

Value

Data frame of package details

Examples

pkgs_ru()
pkgs_ru()

Get the next post date/time

Description

Finds the next date/time to post by day of the week and hour.

Usage

post_time(day, hour)
post_time(day, hour)

Arguments

day

Character. Day of the week (e.g., "Monday")

hour

Numeric. Hour at which to post (e.g., 8)

Value

Date time as character (without timezone)

Examples

post_time("Wednesday", 8)
post_time("Wednesday", 8)

List PRs

Description

List open PRs by url, title and number, optionally matching to a title or branch name (ref)

Usage

prs_list(match = NULL, owner = "ropensci", repo = "roweb3")
prs_list(match = NULL, owner = "ropensci", repo = "roweb3")

Arguments

match

Character. String to match in the title or branch name

owner

Character. GitHub owner of the repository (defaults to 'ropensci')

repo

Character. GitHub repository name (defaults to 'roweb3')

Value

Data frame with PR url, number, title, and branch name ('ref')

Examples

prs_list("coworking") # List all coworking related (open) PRs
prs_list("coworking") # List all coworking related (open) PRs

Replace emoji codes with unicode

Description

Replaces emoji codes like :tada: with unicode like 🎉.

Usage

replace_emoji(x)
replace_emoji(x)

Arguments

x

Character. Text string within which to replace codes

Value

Text string with emoji unicodes

Examples

replace_emoji("hi :tada: testing \n\n\n Whow ! 🔗 \n\n\n :smile:")
replace_emoji(":link:")
replace_emoji("hi :tada: testing \n\n\n Whow ! 🔗 \n\n\n :smile:")
replace_emoji(":link:")

List channels and their ids

Description

List channels and their ids

Usage

slack_channels(channel = NULL, types = c("public_channel", "private_channel"))
slack_channels(channel = NULL, types = c("public_channel", "private_channel"))

Arguments

channel

Character. Channel Name.

types

Character. Type of channels, one or both of "public_channel" or "private_channel"

Value

Data frame of channel names, ids, types, descriptions, and topics. Or if channel provided, a single channel id.

Examples


slack_channels()
slack_channels("general")
chn <- slack_channels(types = "private_channel")

slack_channels()
slack_channels("general")
chn <- slack_channels(types = "private_channel")

Clean up old scheduled messages

Description

Removes previously scheduled messages from ⁠#admin-scheduled⁠ if after the posting date. Only removes messages scheduled by current user.

Usage

slack_cleanup()
slack_cleanup()

Value

Nothing

Examples



slack_posts_write("testing cleanup",
                  when = Sys.time() + lubridate::seconds(600),
                  tz = Sys.timezone())
slack_scheduled_list()

slack_cleanup()

slack_posts_write("testing cleanup",
                  when = Sys.time() + lubridate::seconds(600),
                  tz = Sys.timezone())
slack_scheduled_list()

slack_cleanup()

Remove a Slack message

Description

Use with caution! Note that users can only delete their own messages. If you try to delete another user's message you will get a "Cant Delete Message" message from the Slack API.

Usage

slack_message_rm(msg = NULL, channel = NULL, channel_id = NULL, ts = NULL)
slack_message_rm(msg = NULL, channel = NULL, channel_id = NULL, ts = NULL)

Arguments

msg

Data frame. Output of slack_messages containing message to remove. Should contain columns "channel" and "ts". Note that only the most recent message will be removed.

channel

Character. Channel Name. Not required if channel_id supplied.

channel_id

Character. Channel id.

ts

Numeric. Timestamp to identify message to remove (if no msg)

Value

Nothing. Side effect of removing message from channel

Bulk remove Slack messages

Description

Use with caution! This removes all messages matched by timestamp ts in channel or channel_id. Note that users can only delete their own messages.

Usage

slack_message_rm_bulk(msg, channel = NULL, channel_id = NULL, ts = NULL)
slack_message_rm_bulk(msg, channel = NULL, channel_id = NULL, ts = NULL)

Arguments

msg

Data frame. Output of slack_messages containing messages to remove. Should contain columns "channel" and "ts". Removes all messages.

channel

Character. Channel Name. Not required if channel_id supplied.

channel_id

Character. Channel id.

ts

Numeric. Timestamp to identify message to remove

Value

Nothing. Side effect of removing message from channel

Get the last 100 messages from a channel

Description

Requires one of channel OR channel_id

Usage

slack_messages(channel = NULL, channel_id = NULL)
slack_messages(channel = NULL, channel_id = NULL)

Arguments

channel

Character. Channel Name. Not required if channel_id supplied.

channel_id

Character. Channel id.

Value

Data frame. Messages and details

Examples


slack_messages(channel_id = "C026GCWKA") # General
slack_messages(channel = "General")

slack_messages(channel_id = "C026GCWKA") # General
slack_messages(channel = "General")

Write Slack message

Description

Write a Slack message for posting now or later.

Usage

slack_posts_write(
  body,
  when = "now",
  tz = "America/Winnipeg",
  channel = "#testing-api",
  dry_run = FALSE
)
slack_posts_write(
  body,
  when = "now",
  tz = "America/Winnipeg",
  channel = "#testing-api",
  dry_run = FALSE
)

Arguments

body

Character. Text of message to post.

when

Character or Date/time. When to post message (timezone is ignored, see tz).

tz

Character. Timezone of when.

channel

Character vector. Channel(s) to post message to.

dry_run

Logical. Test run?

Details

See https://docs.slack.dev/messaging/formatting-message-text#special-mentions https://docs.slack.dev/messaging/formatting-message-text#mentioning-users

Value

Success message

References

https://docs.slack.dev/messaging/sending-and-scheduling-messages
https://docs.slack.dev/messaging/sending-and-scheduling-messages#scheduling

Examples


slack_posts_write("testing on Tuesday")
slack_posts_write("testing more and more", when = Sys.time() + 3600, tz = "Europe/Paris")
slack_posts_write(
  paste(
  "Join us for Social Coworking and office hours next week!",
  "",
  ":grey_exclamation: Theme: TESTING",
  ":hourglass_flowing_sand: When: TODAY!",
  ":cookie: Hosted by: USER! and cohost HOST",
  "",
  "You can use this time for...",
  "- General coworking", sep = "\n"), when = "now")

# Dry runs
slack_posts_write("testing on Tuesday", dry_run = TRUE)
slack_posts_write(
  "testing [this cool link](https://mycoolsite.com)",
  dry_run = TRUE
)

slack_posts_write("testing on Tuesday")
slack_posts_write("testing more and more", when = Sys.time() + 3600, tz = "Europe/Paris")
slack_posts_write(
  paste(
  "Join us for Social Coworking and office hours next week!",
  "",
  ":grey_exclamation: Theme: TESTING",
  ":hourglass_flowing_sand: When: TODAY!",
  ":cookie: Hosted by: USER! and cohost HOST",
  "",
  "You can use this time for...",
  "- General coworking", sep = "\n"), when = "now")

# Dry runs
slack_posts_write("testing on Tuesday", dry_run = TRUE)
slack_posts_write(
  "testing [this cool link](https://mycoolsite.com)",
  dry_run = TRUE
)

List currently scheduled messages

Description

Returns the currently scheduled messages with added details regarding timezones, etc.

Usage

slack_scheduled_list()
slack_scheduled_list()

Value

Data frame of currently scheduled messages

Examples


slack_scheduled_list()

slack_scheduled_list()

Delete a scheduled message

Description

Removes a currently scheduled messages. Can only be removed by scheduler.

Usage

slack_scheduled_rm(msg = NULL, channel = NULL, id = NULL)
slack_scheduled_rm(msg = NULL, channel = NULL, id = NULL)

Arguments

msg

Data frame. Output of slack_list_scheduled() containing messages to remove. Should contain columns "channel" and "id"

channel

Character. If no msg, the Channel of the message to be deleted.

id

Character. If no msg, the ID of the message to be deleted.

Value

Nothing

Examples


# Schedule message
slack_posts_write("Testing delete msg", when = (Sys.Date() + lubridate::days(2)))

# Confirm scheduled
slack_scheduled_list()

# Remove message
slack_scheduled_list() |>
  dplyr::filter(text == "Testing delete msg") |>
  slack_scheduled_rm()

# Confirm that removed
slack_scheduled_list()

## Not run: 
slack_scheduled_rm(channel = "#testing-api", id = "Q08U4S3J6QG")

## End(Not run)

# Schedule message
slack_posts_write("Testing delete msg", when = (Sys.Date() + lubridate::days(2)))

# Confirm scheduled
slack_scheduled_list()

# Remove message
slack_scheduled_list() |>
  dplyr::filter(text == "Testing delete msg") |>
  slack_scheduled_rm()

# Confirm that removed
slack_scheduled_list()

## Not run: 
slack_scheduled_rm(channel = "#testing-api", id = "Q08U4S3J6QG")

## End(Not run)

Fetch details on a specific user

Description

Fetch details on a specific user

Usage

slack_user(name, users = NULL)
slack_user(name, users = NULL)

Arguments

name

Character. String to match real name to

users

Data frame. Data frame of users from slack_users().

Value

Data frame

Examples


slack_user("Steffi")

slack_user("Steffi")

Fetch a list of Slack users

Description

Fetch a list of Slack users

Usage

slack_users()
slack_users()

Value

Data frame of Slack users including names and ids

Examples


u <- slack_users()

u <- slack_users()

DEPRECATED - Create a draft issue to post to Mastodon and LinkedIn

Description

Formats the body and title of an issue and posts it on "rosadmin/scheduled_socials". The issue will bed opened in a browser for editing and confirmation. Note that issues will not be posted until the labels "draft" and "needs-review" have been removed.

Usage

socials_post_issue(
  time,
  tz = "America/Winnipeg",
  title,
  body,
  where = "mastodon",
  avoid_dups = TRUE,
  add_hash = TRUE,
  dry_run = FALSE,
  open_browser = TRUE,
  over_char_limit = cli::cli_abort,
  verbose = FALSE
)
socials_post_issue(
  time,
  tz = "America/Winnipeg",
  title,
  body,
  where = "mastodon",
  avoid_dups = TRUE,
  add_hash = TRUE,
  dry_run = FALSE,
  open_browser = TRUE,
  over_char_limit = cli::cli_abort,
  verbose = FALSE
)

Arguments

time

Date/time. Date and time at which the post should be made

tz

Character. Timezone (from OlsonNames()) in which to post

title

Character. Title of the post (⁠[Post]⁠ and the date will be prepended and appended

body

Character. Text to be posted (omit the YAML for posting info; #RStats and @[email protected] will be appended for Mastodon, #RStats for LinkedIn), or link to text file with both Mastodon and LinkedIn body text, headed by by —- Mastodon —– and — LinkedIn —–.

where

Character vector. Either mastodon and/or linkedin to specify which platforms this should be posted on.

avoid_dups

Logical. Don't post an issue if any open issue has the same title.

add_hash

Logical. Whether to automatically add the RStats hashtags.

dry_run

Logical. Whether to perform a dry run (do not post, but display draft if verbose = TRUE).

open_browser

Logical. Whether to open the issue in the browser.

over_char_limit

Function. Error or warn if over the character limit?

verbose

Logical. Show extra informative messages.

Examples

# DEPRECATED
# socials_post_issue("2025-01-01 00:00:00",
#                    title = "test post",
#                    body = "Test body",
#                    dry_run = TRUE, verbose = TRUE)
# DEPRECATED
# socials_post_issue("2025-01-01 00:00:00",
#                    title = "test post",
#                    body = "Test body",
#                    dry_run = TRUE, verbose = TRUE)

Create Throwback Thursday post

Description

Create Throwback Thursday post

Usage

tt_post(
  date,
  title,
  url,
  blurb = "<-- Interesting description/blurb mentioning the author -->",
  dry_run = FALSE,
  print = FALSE
)
tt_post(
  date,
  title,
  url,
  blurb = "<-- Interesting description/blurb mentioning the author -->",
  dry_run = FALSE,
  print = FALSE
)

Arguments

date

YMD Character. Date of the original post.

title

Character. Title of the original post.

url

Character. URL to original blog post

blurb

Character. Interesting bit to describe post (optional).

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

print

Logical. Whether to simply print the text to console instead of copying to the clipboard.

Value

Character string of R functions with relevant details (normally pasted into a POSTS_TT.R script file and tweaked as necessary before being executed).

Examples

# Standard
tt_post(
  "2019-05-14",
  "POWER to the People",
  "https://ropensci.org/blog/2019/05/14/nasapower/",
  print = TRUE
)

# Double throwback
tt_post(
  c("2017-08-22", "2017-08-22"),
  c("So you (don't) think you can review a package",
    "Onboarding visdat, a tool for preliminary visualisation of whole dataframes"
  ),
  url = c(
    "https://ropensci.org/blog/2017/08/22/first-package-review/",
    "https://ropensci.org/blog/2017/08/22/visdat/"
  ),
  print = TRUE
)

# Slug only
tt_post("2019-05-14", "POWER to the People", "nasapower", print = TRUE)
# Standard
tt_post(
  "2019-05-14",
  "POWER to the People",
  "https://ropensci.org/blog/2019/05/14/nasapower/",
  print = TRUE
)

# Double throwback
tt_post(
  c("2017-08-22", "2017-08-22"),
  c("So you (don't) think you can review a package",
    "Onboarding visdat, a tool for preliminary visualisation of whole dataframes"
  ),
  url = c(
    "https://ropensci.org/blog/2017/08/22/first-package-review/",
    "https://ropensci.org/blog/2017/08/22/visdat/"
  ),
  print = TRUE
)

# Slug only
tt_post("2019-05-14", "POWER to the People", "nasapower", print = TRUE)

Review blogposts views for Throwback Thursday highlights

Description

Use matomo_update() and friends to download and update blog post view data. tt_review() summarizes the posts by view and optionally filters to a specific month.

Usage

tt_review(which_month = NULL)
tt_review(which_month = NULL)

Arguments

which_month

Numeric. Which month to return? Numeric 1-12 for month. Default NULL returns all.

Value

Data frame of posts by views with urls

Examples


tt_review(11)

tt_review(11)

Fetch and format use cases from a GitHub Discussion board

Description

Fetch and format use cases from a GitHub Discussion board

Usage

uc_fetch(owner = "ropensci", name = "discussions")
uc_fetch(owner = "ropensci", name = "discussions")

Arguments

owner

Character. Repository owner.

name

Character. Repository for discussions

Value

Data frame of usecases

Examples


u <- uc_fetch()
u

u <- uc_fetch()
u

Extract out resource information

Description

Extract out resource information

Usage

uc_fmt(uc, min_date, pkgs = NULL)
uc_fmt(uc, min_date, pkgs = NULL)

Arguments

uc

Data frame. Data frame of usecases from uc_fetch().

min_date

Character/Date. Minimum date of usecases to retain.

pkgs

Data frame. Optional data frame of package details (defaults to pkgs_ru()).

Value

Data frame of formatted use cases.

Examples


u <- uc_fetch() |>
  uc_fmt("2025-01-01")
u

u <- uc_fetch() |>
  uc_fmt("2025-01-01")
u

Add social media handles

Description

Add social media handles

Usage

uc_handles(uc, force_masto = FALSE)
uc_handles(uc, force_masto = FALSE)

Arguments

uc

Data frame. Formatted use cases output of uc_fmt().

force_masto

Logical. Passed to monarch::add_handles(). Whether or not to force a re-check of mastodon handles (good if you think they've changed or they are 'none' and you want to check again).

Value

Data frame with social media handles appended/filled in

Examples


u <- uc_fetch() |>
  uc_fmt("2025-01-01") |>
  uc_handles()

u <- uc_fetch() |>
  uc_fmt("2025-01-01") |>
  uc_handles()

Create use case `socials_post_issue()` command

Description

Create use case socials_post_issue() command

Usage

uc_post(uc, date_time = NULL, dry_run = FALSE, print = FALSE)
uc_post(uc, date_time = NULL, dry_run = FALSE, print = FALSE)

Arguments

uc

Data frame. Formatted use cases including social media handles and arranged by platform upon which to post, output of uc_platform().

date_time

Character/Date. When to post. Defaults to next Wednesday if NULL.

dry_run

Logical. Whether to do a dry run (i.e. don't talk to the API).

print

Logical. Whether to simply print the text to console instead of copying to the clipboard.

Value

Copies commands to clipboard, optionally prints if (print = TRUE).

Examples


u <- uc_fetch() |>
  uc_fmt("2025-01-01") |>
  uc_handles() |>
  by_platform()

uc_post(u, dry_run = TRUE,print = TRUE)

u <- uc_fetch() |>
  uc_fmt("2025-01-01") |>
  uc_handles() |>
  by_platform()

uc_post(u, dry_run = TRUE,print = TRUE)

Convert an api url to a user-facing url

Description

When working with the GitHub api, urls are often in for the api.

Usage

url_from_api(url)
url_from_api(url)

Arguments

url

Character. URL to convert

Value

User-facing url character string

Examples

url_from_api("https://api.github.com/repos/ropensci/qualtRics/issues/386")
url_from_api("https://api.github.com/repos/ropensci/qualtRics/issues/386")

Create url from content date and slug

Description

Create url from content date and slug

Usage

url_from_path(
  path,
  date = NULL,
  lang = NULL,
  where = "blog",
  base_url = "https://ropensci.org"
)
url_from_path(
  path,
  date = NULL,
  lang = NULL,
  where = "blog",
  base_url = "https://ropensci.org"
)

Arguments

path

Character. Slug, URL, or path to file in repository

date

Character. Date for event, used to create link (otherwise extracted from slug)

lang

Character. Language of blogpost (i.e., en, es, fr, etc.)

where

Character. 'blog' or 'event' depending on the content type.

base_url

Character. Base url of blog posts.

Value

Full url

Examples

url_from_path("my-post", date = "2025-01-01")
url_from_path("2025-01-01-my-post/index.es.md")
url_from_path("content/blog/2025-09-29-news-september-2025/index.md")
url_from_path("content/blog/2025-09-29-news-september-2025/index.Rmd")
url_from_path("content/blog/2025-09-29-news-september-2025/")
url_from_path("my-post", date = "2025-01-01")
url_from_path("2025-01-01-my-post/index.es.md")
url_from_path("content/blog/2025-09-29-news-september-2025/index.md")
url_from_path("content/blog/2025-09-29-news-september-2025/index.Rmd")
url_from_path("content/blog/2025-09-29-news-september-2025/")

Create Word lists for spelling dictionaries

Description

Creates a word list of packages, and/or maintainer, and/or contributor names. If wordlist already exists will update existing list.

Usage

wordlist_create(
  which = c("packages", "maintainers"),
  path = ".wordlists/names.txt"
)
wordlist_create(
  which = c("packages", "maintainers"),
  path = ".wordlists/names.txt"
)

Arguments

which

Character vector. Which words to create lists for? Any of "packages", "maintainers", "contributors".

path

Character. File path to save wordlist to.

Value

Path of new wordlist

Examples


wordlist_create()

wordlist_create()

Add specific words to the wordlist

Description

Add specific words to the wordlist

Usage

wordlist_update(words, path = ".wordlist/names.txt")
wordlist_update(words, path = ".wordlist/names.txt")

Arguments

words

Character vector. Words to add to word list, note that these are all split into individual words by spaces.

path

Character. Where the word list is to be saved/updated.

Value

Path of word list

Extract YAML keys from block

Description

Extract YAML keys from block

Usage

yaml_extract(yaml, trim = "~~~")
yaml_extract(yaml, trim = "~~~")

Arguments

yaml

Character. String from which to extract YAML keys

trim

Character. Text to remove from the YAML block before processing. Usually the text that defines the block.

Value

data frame of yaml keys

Examples


yaml_extract("~~~start: 2023-11-12\nauthor: Steffi\n~~~")

yaml_extract("~~~start: 2023-11-12\nauthor: Steffi\n~~~")

Package 'promoutils'

Help Index

Create a cached version of the GH api calls

Description

Usage

Arguments

Details

List of IDs for Buffer channels: Bluesky, Mastodon, and LinkedIn

Description

Usage

Format

Number of characters permitted by social media channels via Buffer

Description

Usage

Format

rOpenSci Buffer organization id

Description

Usage

Format

Return Buffer channel ids

Description

Usage

Arguments

Value

Examples

Clean up draft/scheduled testing messages

Description

Usage

Value

Examples

Return Buffer Organization account id

Description

Usage

Arguments

Value

Examples

Return a list of Buffer posts

Description

Usage

Arguments

Value

References

Examples

Remove posts on Buffer

Description

Usage

Arguments

Value

Examples

Create a social media post on Buffer

Description

Usage

Arguments

Value

Examples

Arrange by platform

Description

Usage

Arguments

Value

Examples

Cache folder to store data

Description

Usage

Arguments

Value

Examples

Create draft message for checking in with Cohosts

Description

Usage

Arguments

Create draft message for checking in with Cohosts about the Event review

Description

Usage

Arguments

Examples

Fetch details about coworking sessions

Description

Usage

Arguments