Skip to content

Edit readme #6

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.

Sign up for GitHub

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

Open
arytontediarjo wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Edit readme #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fefdb5e
add data quality section
arytontediarjo Sep 20, 2023
edef60a
update readme
arytontediarjo Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions scripts/metadata/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,11 @@ There is no "NTD status" for individuals or households.
#### Comment on script functionality

The `scripts/metadata/generate_metadata.R` script generates the metadata files necessary for the health economics suite of forms. Because the NTD "status" concept does not exist, and because the NTD form's metadata is not dynamic (it is generated once only), the NTD file is written only once. In the metadata generation script, it is written based on all eligible health economics individuals, filtered down only to those who are "pre-selected" for the NTD component of the project. This filtering + writing occurs _before_ filtering for "in" households (which is necessary for the "monthly" forms, since households which are "out" or "eos" should not show up in monthly forms).

#### Data Quality Testing

Series of data quality unit tests will be conducted on each metadata before being uploaded to ODK Central. Tests will be done via `dataqualitybrewr`, which is an R package that we will continuously manage and add in more testing features based on logic and requirements. More documentation on the use-case [here](https://github.com/databrew/dataqualitybrewr/tree/main)

Once all data quality tests have passed, Data will be stored to AWS for capturing all state changes from prior and current visits and ODK Central for drop-down functionality.

Data quality tests will be managed and tracked here in this [Google Sheets](https://docs.google.com/spreadsheets/d/1OrSul3WqtsO_0JzAXShx8LDmLfNZEugVHvj2SsKNRu0/edit?usp=sharing).