inst/doc/getting-started.R

In texanshootR: Reproducible Audit Trails for Indefensible Research

## ----include = FALSE----------------------------------------------------------
knitr::opts_chunk$set(
  collapse = TRUE,
  comment  = "#>",
  eval     = FALSE
)

## -----------------------------------------------------------------------------
# library(texanshootR)
# 
# run <- shoot(mtcars)
# print(run)
# summary(run)

## -----------------------------------------------------------------------------
# run <- shoot(mtcars, presentation = TRUE)

## -----------------------------------------------------------------------------
# res <- tryCatch(manuscript(run), tx_chain_error = function(e) e)
# if (inherits(res, "tx_chain_error")) {
#   res$reason   # one of: not_unlocked, no_active_chain,
#                #         wrong_run, wrong_stage
# }

## -----------------------------------------------------------------------------
# progress()

## -----------------------------------------------------------------------------
# career()        # tier, runs, favourite method, opaque scores
# achievements()  # 20 unlockable badges; hidden ones show as ???
# wardrobe()      # equipped cosmetic slots (hat, badge, cloak, poncho, lanyard)
# run_log()       # tibble of every run on this profile

## -----------------------------------------------------------------------------
# options(texanshootR.save_enabled = FALSE)

## -----------------------------------------------------------------------------
# options(texanshootR.consent = TRUE)

## -----------------------------------------------------------------------------
# reset_career(force = TRUE)
# reset_achievements(force = TRUE)
# reset_wardrobe(force = TRUE)
# reset_all(force = TRUE)