madshapR (version 2.0.0)

as_data_dict_shape: Validate and coerce any object as a workable data dictionary structure

Description

Validates the input object as a workable data dictionary structure and returns it with the appropriate madshapR::class attribute. This function mainly helps validate input within other functions of the package but could be used to check if a data dictionary is valid for use in a function.

Usage

as_data_dict_shape(object)

Value

A list of data frame(s) with madshapR::class 'data_dict_shape'.

Arguments

object

A potential valid data dictionary to be coerced.

Details

A data dictionary contains the list of variables in a dataset and metadata about the variables and can be associated with a dataset. A data dictionary object is a list of data frame(s) named 'Variables' (required) and 'Categories' (if any). To be usable in any function, the data frame 'Variables' must contain at least the name column, with all unique and non-missing entries, and the data frame 'Categories' must contain at least the variable and name columns, with unique combination of variable and name.

See Also

For a better assessment, please use data_dict_evaluate().

Examples

{

library(dplyr)

# use madshapR_examples provided by the package
data_dict <- madshapR_examples$`data_dictionary_example`
data_dict <- as_data_dict_shape(data_dict)
glimpse(data_dict)

}