Build outputs and validate a study (contributor)

Optionally bakes display artifacts with build_study_outputs(), then runs check_replication(). On success the study is ready for a maintainer to register it with sync_study_to_registry() (stub written only into the central registry repository).

Usage

check_and_bake_study(
  location = ".",
  build_artifacts = TRUE,
  install_deps = TRUE,
  full_replication = FALSE,
  registry_root = NULL
)

Arguments

location

Study repo path or GitHub address. Defaults to "." — the current working directory, i.e. the same study doi = "local" resolves to for list_replications() / run_replication() / get_code().

build_artifacts

If TRUE, build precomputed outputs first.

install_deps

Passed to the build function.

full_replication

If TRUE, also run every table and figure live.

registry_root

Optional registry checkout (passed to build/check helpers).

Value

Invisibly, a checklist result (folder_replication_check or package_replication_check).

Examples

if (FALSE) { # \dontrun{
# setwd() to the study repo (or open its RStudio project) first.
setwd("path/to/rep-my-study")

# Manual smoke check before the full contributor checklist — no
# registry required:
list_replications("local")
describe_study_dag("local")
run_replication("local", "tab_1")  # one light step

check_and_bake_study(".")
check_and_bake_study("../rep-10.1017-S0003055403000534")
check_and_bake_study("../rep-template", build_artifacts = TRUE)
} # }