Documentation is important. I found a useful way to include documentation is in the vignettes attached to the R package with the data. A separate R package is used for data analysis, but to understand the data, we create a vignette in the data package first.
However, an error occurred when using the browseVignettes() command:
No vignettes found by browseVignettes('dataPackageName')
This problem can be resolved by installing the data package from the source code and using the flag to install the vignettes.
devtools::build()
devtools::install(build_vignettes=TRUE)
browseVignettes('dataPackageName')
Using the “Install Package” menu item will not install the Vignette.