-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
docsUser-facing documentation/vignettesUser-facing documentation/vignettesmvpMinimum viable productMinimum viable product
Description
Goal
- Ensure each exported dataset is documented and discoverable in R help.
Tasks
- For each exported data object (traitsview + support tables):
- create an
R/<name>.Rfile containing roxygen2@docType datadocumentation - include: title, description, source, variables (key columns), and examples
- create an
- Ensure docs build cleanly with
devtools::document().
Acceptance criteria
?traitsviewworks and describes the dataset clearly.help(package = "betydata")lists the datasets.R CMD checkpasses without undocumented objects.
Non-goals
- No extra wrapper functions or complex APIs.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
docsUser-facing documentation/vignettesUser-facing documentation/vignettesmvpMinimum viable productMinimum viable product