create_entities_from_yaml: create EML and data entities from a data resources yaml file

View source: R/create_entities_from_yaml.R

create_entities_from_yamlR Documentation

create EML and data entities from a data resources yaml file

Description

create_entities_from_yaml takes a single list of configuration details for a single data entity harvested from a data resources yaml file. The appropriate data entity object (e.g., EML::dataTable and side effects if relevant (e.g., creating the entity resource)) are generated from the passed configuration details. This is essentially identical to calling, for example, my_table <- capeml::create_dataTable(dfname = my_table, description = my_table_desc, ...) except that the arguments for create_dataTable, create_otherEntity, etc. are articulated in a data resources yaml file that is read by create_dataset. Passing create_entities_from_yaml to a purrr workflow (within create_dataset) enables constructing all relevant data entities from a single yaml file.

Usage

create_entities_from_yaml(entity_configuration)

Arguments

entity_configuration

(list) data entity configuration details for a single data entity read from a data resources yaml file

Value

a data entity added to a list of that type in the parent or global environment


CAPLTER/capeml documentation built on April 3, 2024, 11:17 p.m.