Applies a data dictionary to a dataset, creating a labelled dataset with variable attributes. Any previous attributes will be preserved. For variables that are factors, variables will be transformed into haven-labelled variables.

data_dict_apply(dataset, data_dict = NULL)



A dataset object.


A list of data frame(s) representing metadata of the input dataset. Automatically generated if not provided.


A labelled data frame with metadata as attributes, specified for each variable from the input data dictionary.


A dataset is a data table containing variables. A dataset object is a data frame and can be associated with a data dictionary. If no data dictionary is provided with a dataset, a minimum workable data dictionary will be generated as needed within relevant functions. Identifier variable(s) for indexing can be specified by the user. The id values must be non-missing and will be used in functions that require it. If no identifier variable is specified, indexing is handled automatically by the function.

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

dataset <- madshapR_DEMO$dataset_MELBOURNE
data_dict <- as_data_dict_mlstr(madshapR_DEMO$data_dict_MELBOURNE)
head(data_dict_apply(dataset, data_dict))

#> # A tibble: 6 × 6
#>       id Gender       BMI age       smo_status                 prg_curr         
#>    <dbl> <dbl+lbl>  <dbl> <dbl+lbl> <dbl+lbl>                  <dbl+lbl>        
#> 1 377943 2 [Female]  22.1 52          1 [never smoked]           0 [not current…
#> 2 497013 1 [Male]    18.5 49          2 [current smoker]       -77 [not applica…
#> 3 927676 1 [Male]    24.6 43          3 [former smoker]        -77 [not applica…
#> 4 995667 2 [Female]  15.7 59        -77 [don't want to answer]   1 [currently p…
#> 5  21829 2 [Female]  18.6 40         NA                          0 [not current…
#> 6 209432 1 [Male]    15.9 47          2 [current smoker]       -77 [not applica…