Skip to contents

Read the study manifest

Source: R/study_config.R
study_config.Rd

Walks up from start until a _study.yml is found, parses it, validates the requested identity or data contract, and returns the result with the study root attached.

A study without a manifest must not render, so an absent _study.yml is an error rather than a set of defaults. The directories walked are named in the error, because the usual cause is starting from outside the study tree.

Study identity always requires study. With require_data = TRUE, built is also required. It must carry its file extension, because the reader dispatches on the extension.

Usage

study_config(start = getwd(), require_data = TRUE)

Arguments

start

Character. Directory to start the upward walk from. Defaults to getwd().

require_data

Logical. If TRUE, require the default dataset and registered file. Use FALSE when only study identity is needed.

Value

The manifest as a list, with root and file attached. Additive identity and named-dataset fields are retained.

See also

study_root, record_provenance

Examples

root <- file.path(tempdir(), "study-example")
dir.create(root, showWarnings = FALSE)
yaml::write_yaml(
  list(study = "Example", built = "example.sas7bdat"),
  file.path(root, "_study.yml")
)
cfg <- study_config(root)
cfg$study
#> [1] "Example"
unlink(root, recursive = TRUE)