This closes #16 and is a stacked PR the depends on #45.
I originally had the required_variables as an internal dataset, but it makes more sense that more of the variable-description data is "exported" (available to the user) so that they can use that if needed. Converting into a "exported" object is done by saving it to data/ as a .rda object (via usethis::use_data()).
I included documentation on that dataset in R/variable-description.R.
I created an get_ helper function to extract the required variables from a given register (along with unit tests for the helper functions).
This closes #16 and is a stacked PR the depends on #45.
I originally had the
required_variablesas an internal dataset, but it makes more sense that more of thevariable-descriptiondata is "exported" (available to the user) so that they can use that if needed. Converting into a "exported" object is done by saving it todata/as a.rdaobject (viausethis::use_data()).I included documentation on that dataset in
R/variable-description.R.I created an
get_helper function to extract the required variables from a given register (along with unit tests for the helper functions).