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_examples provided by the package
names_in_data_dict <- 
  madshapR_examples$`data_dictionary_example - errors`$`Variables`$`name`
check_name_standards(names_in_data_dict)
check_name_standards(c("coucou", "cou cou", "$coucou",NA))

}
#> # A tibble: 3 × 2
#>   name_var      condition                                                       
#>   <chr>         <chr>                                                           
#> 1 cou cou       [INFO] - Variable names contain special characters, contain spa…
#> 2 $coucou       [INFO] - Variable names contain special characters, contain spa…
#> 3 Row number: 4 [ERROR] - Variable name is empty.