chevron_tlg class — chevron_tlg-class • chevron

The chevron_tlg class associates a preprocess function, a main tlg function and AdAM tables names and optionally a postprocess function.

Usage

chevron_tlg(
  main = function(adam_db, ...) adam_db,
  preprocess = function(adam_db, ...) adam_db,
  postprocess = report_null,
  adam_datasets = NA_character_
)

Arguments

main: (function) returning a tlg. Typically one of the _main function of chevron.
preprocess: (function) returning a pre-processed dm object amenable to tlg creation. Typically one of the _pre function of chevron.
postprocess: (function) returning a post-processed tlg.
adam_datasets: (character) representing the name of the table from an AdAM dataset required for tlg creation.

Functions

chevron_tlg(): Default Constructor

Slots

main: (function) returning a tlg. Typically one of the *_main function from chevron.
preprocess: (function) returning a pre-processed dm object amenable to tlg creation. Typically one of the *_pre function from chevron.
postprocess: (function) returning a post-processed tlg.
adam_datasets: (character) representing the name of the tables from an AdAM dataset required for tlg creation.

Note

To ensure the correct execution of the workflow additional validation criteria are:

the first argument of the main function must be adam_db, the input dm object to pre-process.
the first argument of the preprocess function must be adam_db, the input dm object to create tlg output.
the first argument of the postprocess function must be tlg, the input TableTree object to post-process.

Examples

x <- chevron_tlg(aet01_1_main, aet01_1_pre, adam_datasets = c("adsl", "adae"))