search

brittanyblouin / ANCRTAdjust

An R package to adjust routine HIV testing data from antenatal care to reduce bias in estimating HIV prevalence trends
MIT License
2 stars 3 forks source link

Using the data cleaning tools - vignette #16

Closed seabbs closed 4 years ago

seabbs commented 4 years ago

As discussed in the paper this package is meant to provide guidelines for clear and simple data handling.

To do this more fully a walkthrough is needed starting with a dataset and stepping through each step. This would give an analyst with some data a pipeline to follow rather than the current situation where you are giving them a toolbox of tools to use.

Having documentation in this pipeline giving a high level overview of what each function does would also be great (this high level explanation is also needed in the function documentation itself).

An example of this is data_clean which does quite a few things - not all of which are immediately obvious from a quick scan of the present docs. Having this set up also means I need to go from docs to function docs and back just to get an understanding of what the package is doing - which is not ideal.

Linked to this #14 issue.

For this # openjournals/joss-reviews/issues/1740 review

m-maheu-giroux commented 4 years ago

We agree with your assessment and have considerably re-written the README to reflect your concerns. We now provide detailed step-by-step information on the data cleaning and analysis pipeline.

seabbs commented 4 years ago

This is much improved. New layout gives me a much better idea of the pipeline.