R package help for whole package

46 Views Asked by At

Some packages (e.g. base) display a help page describing the package when the command help("base") or ?base is given.

How can this be accomplished when creating a package when roxygen2 is used to create the documentation?

1

There are 1 best solutions below

0
uke On

See this chapter of R Packages (2e) by Hadley Wickham and Jennifer Bryan: Documentation/Function documentation/Help topic for the package.

We recommend calling usethis::use_package_doc() to set up this package-level documentation in a dummy file R/{pkgname}-package.R, whose contents will look something like this:

#' @keywords internal 
"_PACKAGE"