Skip to content

More explicit on documenting data sets #1664

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

More explicit on documenting data sets #1664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion vignettes/rd-other.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@ This means you need to document them in a slightly different way: instead of doc
#' }
#'
#' @source {ggplot2} tidyverse R package.
"diamonds"
```

Note the use of two additional tags that are particularly useful for documenting data:
This generates documentation for the `data(diamonds)` object. Note the use of two additional tags that are particularly useful for documenting data:

- `@format`, which gives an overview of the structure of the dataset.
This should include a **definition list** that describes each variable.
Expand Down
Loading