Skip to content
reportifyr documentation

Get Meta Abbreviations

The get_meta_abbrevs() function in the reportifyr package retrieves standardized abbreviations (meta_abbrevs) from a specified standard_footnotes.yaml file.

get_meta_abbrevs()

R: Get meta abbreviations from standard_footnotes.yaml
get_meta_abbrevsR Documentation

Description

Get meta abbreviations from standard_footnotes.yaml

Usage

get_meta_abbrevs(path_to_footnotes_yaml)

Arguments

path_to_footnotes_yaml

The file path to the standard_footnotes.yaml file.

Value

A list of meta_abbrevs to be called while performing an analysis

Examples

## Not run: 
standard_footnotes_yaml <- here::here("report", "standard_footnotes.yaml")
meta_abbrevs <- get_meta_abbrevs(path_to_footnotes_yaml = standard_footnotes_yaml)

## End(Not run)

Returns

A named list of abbreviations from the standard_footnotes.yaml file.

Logging

  • Debug: Logs the start and end of the function, the successful reading of standard_footnotes.yaml, and the successful extraction of meta_abbrevs.
  • Error: Logs errors for missing files, incorrect file types, or missing required fields within standard_footnotes.yaml.

Additional Resources

  • reportifyr GitHub: Refer to the reportifyr repository for more details.
  • YAML Documentation: Learn more about YAML syntax and structure here.