API

# API for touchstone package

## Exported functions

activate(head_branch = gert::git_branch(), base_branch = getOption("touchstone.default_base_branch", "main"), n = 1, env = parent.frame())
benchmark_analyze(branches = c(branch_get_or_fail("GITHUB_BASE_REF"), branch_get_or_fail("GITHUB_HEAD_REF")), names = NULL, ci = 0.95)
benchmark_ls(name)
benchmark_read(name, branch)
benchmark_run(expr_before_benchmark = {}, ..., branches = c(branch_get_or_fail("GITHUB_BASE_REF"), branch_get_or_fail("GITHUB_HEAD_REF")), n = 100, path_pkg = ".")
benchmark_write(benchmark, name, branch, block = NA, iteration = NA, append = TRUE)
branch_get_or_fail(var)
branch_install(branches = c(branch_get_or_fail("GITHUB_BASE_REF"), branch_get_or_fail("GITHUB_HEAD_REF")), path_pkg = ".", install_dependencies = FALSE)
deactivate(env = parent.frame())
dir_touchstone()
path_pinned_asset(..., branch = branch_get_or_fail("GITHUB_HEAD_REF"))
path_pr_comment()
pin_assets(..., branch = branch_get_or_fail("GITHUB_HEAD_REF"), overwrite = TRUE)
run_script(path = "touchstone/script.R", branch = branch_get_or_fail("GITHUB_HEAD_REF"))
touchstone_clear(all = FALSE)
use_touchstone(overwrite = FALSE, command = NULL, limit_to = c("OWNER", "MEMBER", "COLLABORATOR"), force_upstream = TRUE)
use_touchstone_workflows(overwrite = FALSE, command = NULL, limit_to = c("OWNER", "MEMBER", "COLLABORATOR"), force_upstream = TRUE)