Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: include variable description as exported dataset as well as a function to get the required variables #48

Merged
merged 15 commits into from
Mar 15, 2024

Conversation

lwjohnst86
Copy link
Member

@lwjohnst86 lwjohnst86 commented Mar 8, 2024

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).

@lwjohnst86 lwjohnst86 self-assigned this Mar 8, 2024
R/get-variables.R Show resolved Hide resolved
R/variable-description.R Outdated Show resolved Hide resolved
R/variable-description.R Show resolved Hide resolved
R/verify-variables.R Outdated Show resolved Hide resolved
Base automatically changed from feat/check-variables to main March 15, 2024 12:49
@lwjohnst86 lwjohnst86 merged commit ba24410 into main Mar 15, 2024
1 of 3 checks passed
@lwjohnst86 lwjohnst86 deleted the feat/list-needed-vars branch March 15, 2024 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Function to list all registers needed as well as all variables needed
3 participants