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

Custom {roxygen} tags #1

Open
aspina7 opened this issue Sep 5, 2024 · 0 comments
Open

Custom {roxygen} tags #1

aspina7 opened this issue Sep 5, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@aspina7
Copy link
Contributor

aspina7 commented Sep 5, 2024

Could consider adding custom tags to documentation - e.g. could be useful for:

  • licensing: datasets could have different licenses to the overall repo, currently written at end of 'description' section, but could add a dedicated bit for this
  • versioning: dataset spinoffs that come from the same original (e.g. ebola having different combos in the intro course), currently written at end of 'description' section, but could add a dedicated bit for this
  • language: once datasets are translated then we would need to also do documentation in other languages. currently written at end of 'description' section, but could add a dedicated bit for this
  • dictionaries: could link to the associated data dictionary documentation

Separately:

  • extdata: current process is to have both the original file and an rda version, only the rda versions can have documents as stands, but could extend to not necessarily need to have all files being rda.
    • alternatively - we could just document in the RDA doc what the original file was and then link to the data-raw script used in recoding.
@aspina7 aspina7 added the enhancement New feature or request label Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant