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

Finalization of the codebook and documentation #2

Open
nickdickinson opened this issue Nov 4, 2021 · 3 comments
Open

Finalization of the codebook and documentation #2

nickdickinson opened this issue Nov 4, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nickdickinson
Copy link
Member

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

@nickdickinson nickdickinson added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 4, 2021
@larnsce
Copy link
Collaborator

larnsce commented May 16, 2023

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

@larnsce larnsce mentioned this issue May 16, 2023
12 tasks
@nickdickinson
Copy link
Member Author

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
Copy link
Collaborator

larnsce commented May 25, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

3 participants