read_spec: Read yaml spec file

In autoslider.core: Slide Automation for Tables, Listings and Figures

Read yaml spec file

Description

Read yaml spec file and split according to filter lists

Usage

read_spec(spec_file = "spec.yml", metadata = NULL)

Arguments

spec_file

'character'. Path to a yaml spec file

metadata

Study-level token values merged into every spec entry. Either a named 'list' (or 'NULL'), or a 'character(1)' path to a yaml metadata file (see [read_metadata()] and the example at 'system.file("metadata.yml", package = "autoslider.core")'), which is read into a list for you. Its elements can be referenced as '{token}' placeholders in the 'titles' and 'footnotes' fields of the spec and are substituted during decoration (see [apply_tokens()]). For example, with 'metadata = list(study = "BP12345")' a spec title of '"Demographics - Study {study}"' becomes '"Demographics - Study BP12345"'.

Value

An object of class 'spec' which is a 'list' where each element corresponds to one output, e.g. 't_dm_IT'.

Author(s)

- Liming Li ('Lil128') - Thomas Neitmann ('neitmant') - Joe Zhu

Examples

spec_file <- system.file("spec.yml", package = "autoslider.core")

## Take a look at the 'raw' content of the spec file
cat(readLines(spec_file)[1:24], sep = "\n")

## This is how it looks once read into R
spec <- read_spec(spec_file)
spec[1:3]

## Supply study metadata so that `{token}` placeholders in titles/footnotes
## are filled in during decoration (e.g. a title of "... Study {study}").
spec <- read_spec(spec_file, metadata = list(study = "BP12345"))

## The same metadata can be kept in a yaml file and read via `read_spec()`
metadata_file <- system.file("metadata.yml", package = "autoslider.core")
spec <- read_spec(spec_file, metadata = metadata_file)

autoslider.core documentation built on Sept. 29, 2026, 5:08 p.m.