Assess variable names in a data dictionary for non-standard formats

Source: R/05-unit_checks.R

Generates a data frame report of any variable names that are not compatible in Maelstrom Research ecosystem, including Opal. This report can be used to help assess data structure, presence of fields, coherence across elements, and taxonomy or data dictionary formats.

check_name_standards(var_names)

Arguments

var_names

A character vector of names.

Value

A data frame providing non-standard names across a vector.

Details

The object may be specifically formatted to be compatible with additional Maelstrom Research software, in particular Opal environments.

Examples

{

# use madshapR_DEMO provided by the package

check_name_standards(c("coucou", "cou cou", "$coucou",NA))
check_name_standards(
 madshapR_DEMO$`data_dict_TOKYO - errors`$Variables$name)

}
#> # A tibble: 1 × 2
#>   name_var  condition                                                           
#>   <chr>     <chr>                                                               
#> 1 weight dc [INFO] - Incompatible variable names with usual standards, includin…