inst/templates/roxygen2-dataset-documentation.R

In r-pkg-examples/pkgdesign: R Package Design Patterns

#' Name of Sample Data Set
#'
#' Paragraph describing the data set.
#'
#' @format
#' A `data.frame` consisting of **OBSERVATIONS** rows and **VARIABLES** columns.
#'
#' Variables included are:
#'
#' \describe{
#'  \item{`x`}{First variable description...}
#'  \item{`y`}{Second variable description...}
#' }
#'
#' @source Who made the data set?
#'  <https://www.website.com/where/dataset/is/located>
"name_of_dataset"