R: Package-level documentation

use_package_doc {usethis} | R Documentation

## Package-level documentation

### Description

Adds a dummy `.R` file that will prompt roxygen to generate basic package-level documentation. If your package is named "foo", this will make help available to the user via `?foo` or `package?foo`. Once you call `devtools::document()`, roxygen will flesh out the `.Rd` file using data from the `DESCRIPTION`. That ensures you don't need to repeat the same information in multiple places. This `.R` file is also a good place for roxygen directives that apply to the whole package (vs. a specific function), such as global namespace tags like `@importFrom`.

### Usage

    use_package_doc()

### See Also

The documentation chapter of R Packages

[Package usethis version 1.4.0 Index]