heims_data_dict {heims} | R Documentation |
HEIMS data dictionary
Description
HEIMS data dictionary
Usage
heims_data_dict
Format
A named list each containing 5 elements:
long_name
a human-readable version of the variable;
orig_name
the element number;mark_missing
a vectorized-function returning
TRUE
on values of the variable which should be coded asNA
;ad_hoc_prepare
a function to apply before validation;
validate
a single-value function returning
TRUE
orFALSE
on vectors which comply with the variable's coding rules.ad_hoc_validation_note
If the data dictionary did not cover elements in the file, how the
validate
function was altered to suffer them.valid
a vectorized function returning
TRUE
orFALSE
on vectors which do not comply with the variable's coding rules.decoder
A function of the
data.table
decoding the variable decoded.post_fst
A function of the
data.table
returned by fst to be used (for example to reset attributes).
Details
Abbreviations in long_name
:
amt
Amount
cd
Code
det
Detail(s)
FOE
Field of education
Maj
Major
Source
http://heimshelp.education.gov.au/sites/heimshelp/dictionary/pages/data-element-dictionary