madshapR (version 2.0.0)

is_data_dict_mlstr: Test if an object is a valid Maelstrom data dictionary

Description

Tests if the input object is a valid data dictionary compliant with formats used in Maelstrom Research ecosystem, including Opal. This function mainly helps validate input within other functions of the package but could be used to check if an object is valid for use in a function.

Usage

is_data_dict_mlstr(object)

Value

A logical.

Arguments

object

A potential Maelstrom formatted data dictionary to be evaluated.

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

{

# use madshapR_examples provided by the package
is_data_dict_mlstr(madshapR_examples$`data_dictionary_example - errors`)
is_data_dict_mlstr(madshapR_examples$`data_dictionary_example - errors with data`)
is_data_dict_mlstr(madshapR_examples$`data_dictionary_example`)
is_data_dict_mlstr(iris)

}