Finalization of the codebook and documentation

WASHNote / jmpwashdata

R package for WHO/UNICEF JMP data

Other

6 stars 1 forks source link

Finalization of the codebook and documentation #2

Open nickdickinson opened 3 years ago

nickdickinson commented 3 years ago

Currently working on completing the csv file codebook and helper functions that will generate documentation for the R package in a human readable format so users know what the package contains and to be able to publish the package to CRAN

larnsce commented 1 year ago

Is this still active? This is something I could support.

nickdickinson commented 1 year ago

This is very much still active. I find this approach pretty nice with minimal dependencies except a good csv/excel based code book: https://jsta.rbind.io/blog/automated-roxygen-documentation-of-r-package-data/

So I believe the steps are:

[ ] Finish code books (variable names, descriptions, etc.) - already started with some exchanges between @nickdickinson @donmezayca @merellaauwen - I don't think we need to wait for that, but @donmezayca said there would be some changes on the JMP end so good to follow!
[ ] Add code to generate tables in the documentation for each dataset

larnsce commented 1 year ago

Great! The approach you have used is also one that we are following in openwashdata. We are going to have a package and currently have this as a function to generate the roxygen2 documentation.

https://github.com/openwashdata/openwashdata/blob/main/R/generate_roxygen_docs.R

Finish code books (variable names, descriptions, etc.) - already started with some exchanges between @nickdickinson @donmezayca @merellaauwen - I don't think we need to wait for that, but @donmezayca said there would be some changes on the JMP end so good to follow!

Who is doing this? And where are the codebooks stored?