heims_data_dict

datasets

Decode elements of the Australian Higher Education Information Management System (HEIMS) data for clarity and performance. HEIMS is the record system of the Department of Education, Australia to record enrolments and completions in Australia's higher education system, as well as a range of relevant information. For more information, including the source of the data dictionary, see <http://heimshelp.education.gov.au/sites/heimshelp/dictionary/pages/data-element-dictionary>.

Hugh Parsonage

heims

Decode and Validate HEIMS Data from Department of Education,
Australia

heims_data_dict function

A named list each containing 5 elements:<dl class="dl-horizontal">
<dt><code>long_name</code></dt><dd>a human-readable version of the variable; <code>orig_name</code> the element number;</dd>
<dt><code>mark_missing</code></dt><dd>a vectorized-function returning <code>TRUE</code> on values of the variable which should be coded as <code>NA</code>;</dd>
<dt><code>ad_hoc_prepare</code></dt><dd>a function to apply before validation;</dd>
<dt><code>validate</code></dt><dd>a single-value function returning <code>TRUE</code> or <code>FALSE</code> on vectors which comply with the variable's coding rules.</dd>
<dt><code>ad_hoc_validation_note</code></dt><dd>If the data dictionary did not cover elements in the file, how the <code>validate</code> function was altered to suffer them.</dd>
<dt><code>valid</code></dt><dd>a vectorized function returning <code>TRUE</code> or <code>FALSE</code> on vectors which do not comply with the variable's coding rules.</dd>
<dt><code>decoder</code></dt><dd>A function of the <code>data.table</code> decoding the variable decoded.</dd>
<dt><code>post_fst</code></dt><dd>A function of the <code>data.table</code> returned by fst to be used (for example to reset attributes).</dd>
</dl>

Format

HEIMS data dictionary — heims_data_dict

A named list each containing 5 elements:<dl class='dl-horizontal'>
<dt><code>long_name</code></dt><dd>a human-readable version of the variable; <code>orig_name</code> the element number;</dd>
<dt><code>mark_missing</code></dt><dd>a vectorized-function returning <code>TRUE</code> on values of the variable which should be coded as <code>NA</code>;</dd>
<dt><code>ad_hoc_prepare</code></dt><dd>a function to apply before validation;</dd>
<dt><code>validate</code></dt><dd>a single-value function returning <code>TRUE</code> or <code>FALSE</code> on vectors which comply with the variable's coding rules.</dd>
<dt><code>ad_hoc_validation_note</code></dt><dd>If the data dictionary did not cover elements in the file, how the <code>validate</code> function was altered to suffer them.</dd>
<dt><code>valid</code></dt><dd>a vectorized function returning <code>TRUE</code> or <code>FALSE</code> on vectors which do not comply with the variable's coding rules.</dd>
<dt><code>decoder</code></dt><dd>A function of the <code>data.table</code> decoding the variable decoded.</dd>
<dt><code>post_fst</code></dt><dd>A function of the <code>data.table</code> returned by fst to be used (for example to reset attributes).</dd>
</dl>

heims_data_dict: HEIMS data dictionary

Description

Usage

Arguments

Format

Details