Skip to contents

Builds a lightweight registry stub from the study's root replication.yml (via build_registry_stub_from_meta()) and writes it to studies/<folder>.yml in a registry checkout, then rebuilds index.csv via build_registry_index(). Prefer the public register_study() entry point for validate-then-sync.

Usage

sync_study_to_registry(
  location = ".",
  registry_root = NULL,
  audit = FALSE,
  patience = 20,
  install_deps = FALSE,
  verbose = TRUE
)

Arguments

location

Study repo path or GitHub address. Defaults to ".".

registry_root

Path to the registry repository root. Defaults to getOption("replicateEverything.registry_root").

audit

If TRUE, run audit_everything() for this study after sync.

patience

Seconds per replication when audit = TRUE.

install_deps

Passed to audit_everything() when audit = TRUE.

verbose

Passed to audit_everything() when audit = TRUE.

Value

Invisibly, a list with stub_path, index_updated, folder, and optional audit.

Details

Stub and index files belong in the registry repository only — not in the study repo.