DataDictionary: DataDictionary

In elfatherbrown/dsmanager: Dataset Management for the OAS Atlas Project.

Description

The class representing a canonical data dictionary

Methods

Public methods

• DataDictionary$new()

• DataDictionary$validate_datadict()

• DataDictionary$document_data()

• DataDictionary$clone()

---

Method new()

Initialize the DataDictionary with the data it documents and at least a mock data dictionary

Usage

DataDictionary$new(dataset_code, datadict)

Arguments

dataset_code

uniquely identifies a dataset

datadict

an existing datadict to be validated. It is expected the user does the initial work of at least a basic data dictionary.

Returns

---

Method validate_datadict()

Usage

DataDictionary$validate_datadict(datadict)

---

Method document_data()

Usage

DataDictionary$document_data(data, only_new = TRUE)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DataDictionary$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

elfatherbrown/dsmanager documentation built on Dec. 20, 2021, 4:16 a.m.