Skip to contents

Output Boilerplate for the "Add Labels and Attributes" Vignette Section

Source: R/user_helpers.R
admiral_labels_attrs_section.Rd

Outputs the standard markdown text used in ADaM-specific vignettes for the "Add Labels and Attributes" section. This function is intended to be called inside an R Markdown code chunk with results='asis' and echo=FALSE.

Usage 

admiral_labels_attrs_section()

Value

No return value. The function outputs text directly to the console or output stream via cat(), intended for use in R Markdown documents with results='asis'.

Details

The outputted section describes how to add variable labels and other metadata to ADaM datasets as a final step in the derivation process, using the {metacore}, {metatools}, and {xportr} packages.

Examples 

admiral_labels_attrs_section()
#> ## Add Labels and Attributes {#attributes}
#> 
#> Note that attributes may not be preserved in some cases after processing
#> with `{admiral}`. The recommended approach is to apply variable labels
#> and other metadata as a final step in your data derivation process using
#> packages like:
#> 
#> -   [metacore](https://atorus-research.github.io/metacore/): establish a
#>     common foundation for the use of metadata within an R session.
#> 
#> -   [metatools](https://pharmaverse.github.io/metatools/): enable the
#>     use of metacore objects. Metatools can be used to build datasets or
#>     enhance columns in existing datasets as well as checking datasets
#>     against the metadata.
#> 
#> -   [xportr](https://atorus-research.github.io/xportr/): functionality
#>     to associate all metadata information to a local R data frame,
#>     perform data set level validation checks and convert into a
#>     [transport v5 file(xpt)](https://documentation.sas.com/doc/en/pgmsascdc/9.4_3.5/movefile/n1xbwdre0giahfn11c99yjkpi2yb.htm).
#> 
#> NOTE: Together with `{admiral}` these packages comprise an End to End
#> pipeline under the umbrella of the
#> [pharmaverse](https://github.com/pharmaverse). An example of applying
#> metadata and performing associated checks can be found at the [pharmaverse
#> E2E example](https://pharmaverse.github.io/examples/adam/adsl).