| is_data_dict_mlstr {madshapR} | R Documentation |
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)
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.
Value
A logical.
See Also
For a better assessment, please use data_dict_evaluate().
Examples
{
# use madshapR_DEMO provided by the package
data_dict <- madshapR_DEMO$data_dict_MELBOURNE
is_data_dict_mlstr(data_dict)
is_data_dict_mlstr(iris)
}