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

Merged
hadley merged 3 commits into from
Mar 2, 2026
Merged

More explicit on documenting data sets #1664

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b999fb5
More explicit on documenting data sets
MichaelChirico Oct 12, 2024
0a4fcd3
Merged origin/main into MichaelChirico-patch-4
hadley Mar 2, 2026
9bc194d
Slight tweak
hadley Mar 2, 2026
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
2 changes: 2 additions & 0 deletions vignettes/rd-other.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ knitr::opts_chunk$set(
Datasets are stored in `data/`, not as regular R objects in the package.
This means you need to document them in a slightly different way: instead of documenting the data directly, you quote the dataset's name.

For example, this roxygen2 block will documentation for `data(diamonds)`:

```{r}
#' Prices of over 50,000 round cut diamonds
#'
Expand Down