R/05-unit_checks.R
check_data_dict_categories.RdGenerates a data frame report of any categorical variable name present in the 'Categories' element but not present in 'Variables'. The data frame also reports any non-unique combinations of 'variable' and 'name' in the 'Categories' element. This report can be used to help assess data structure, presence of fields, coherence across elements, and taxonomy or data dictionary formats.
check_data_dict_categories(data_dict)A list of data frame(s) representing metadata to be evaluated.
A data frame providing categorical variables that has issues within a data dictionary.
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.
{
# use madshapR_DEMO provided by the package
data_dict <- madshapR_DEMO$`data_dict_TOKYO - errors`
check_data_dict_categories(data_dict)
}
#> # A tibble: 5 × 3
#> name_var value condition
#> <chr> <chr> <chr>
#> 1 prg_ever NA [ERR] - Categories not present in the variable names…
#> 2 prg_ever row number: 12 [ERR] - In 'name', the value cannot be NA
#> 3 weight_sm NA [ERR] - Categories not present in the variable names…
#> 4 NA row number: 10 [ERR] - In 'variable', the value cannot be NA
#> 5 prg_ever -7 [ERR] - Category names not unique in the data dictio…