Initiate touchstone

This function will initialize touchstone in your package repository, use from root directory.

use_touchstone(
  overwrite = FALSE,
  command = NULL,
  limit_to = c("OWNER", "MEMBER", "COLLABORATOR"),
  force_upstream = TRUE
)

Arguments

overwrite: Overwrites files if they exist.
command: If set to NULL (the default) will run the workflow on every commit. If set to a command (e.g. /benchmark) the benchmark will only run when triggered with a comment on the PR starting with the command.
limit_to: Roles that are allowed to trigger the benchmark workflow via comment. See details for a list of roles and their definition. Set to NULL to allow everyone to trigger a benchmark.
force_upstream: Always benchmark against the upstream base branch.

The function is called for its side effects and returns NULL (invisibly).

For more information see the 'Using touchstone' vignette: `vignette("touchstone", package = "touchstone")

if (FALSE) { # \dontrun{
# within your repository
use_touchstone()
} # }