use_ref_map: Read and use a mapping file

In nf-osi/nfportalutils: NF Portal Utilities

Read and use a mapping file

Description

The mapping file should be a YAML or JSON format file that minimally has a mapping key storing the translations of source data model element to the target data model. See example file for NF. This util reads the mapping file, does some light checking, and creates a list object that downstream functions can use.

Usage

use_ref_map(ref_map, as_dt = TRUE)

Arguments

ref_map	YAML or JSON mapping. See details.
as_dt	Return as data.table, the default, otherwise do checking but just return the list representation, which retains some metadata.

Details

If the specification for the mapping file is later formalized with a different structure this should be handled accordingly (that is to say, this is one of the under-the-hood things that can change).

Value

Either a list of lists storing source, label, description, data_type, attribute_type or a data.table representation.

nf-osi/nfportalutils documentation built on Feb. 26, 2024, 1:05 p.m.