
Validate then sync a study into the registry (maintainer)
Source:R/prepare_folder_paper.R
register_study.RdRuns check_and_bake_study() then syncs a lightweight stub into the local
registry checkout and rebuilds index.csv. Use when a maintainer has a
study checkout and a registry checkout.
Usage
register_study(
location = ".",
build_artifacts = FALSE,
install_deps = TRUE,
full_replication = FALSE,
registry_root = NULL,
dry_run = FALSE,
audit = FALSE
)Arguments
- location
Study repo path or GitHub address. Defaults to
"."— the current working directory, i.e. the same studydoi = "local"resolves to forlist_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).
- dry_run
If
TRUE, run checks only; do not write registry files.- audit
If
TRUE, runaudit_everything()for this study after sync.
Value
Invisibly, the checklist result; when registration succeeds, also
includes stub_path and index_updated.
Examples
if (FALSE) { # \dontrun{
options(replicateEverything.registry_root = "../registry")
register_study(".", registry_root = "../registry")
} # }