add_package_doc: Create a package-level documentation file

Description Usage Arguments Value See Also Examples

View source: R/add_package_doc.R

Description

This function adds a package-level documentation file (pkg-package.R) in the R/ folder. This file will make help available to the user via ?pkg (where pkg is the name of the package). It a good place to put general directives like @import and @importFrom.

Usage

1
add_package_doc(open = TRUE, overwrite = FALSE, quiet = FALSE)

Arguments

open

a logical value

If TRUE (default) the file is opened in the editor.

overwrite

a logical value

If this file is already present and overwrite = TRUE, it will be erased and replaced. Default is FALSE.

quiet

a logical value

If TRUE messages are deleted. Default is FALSE.

Value

None

See Also

Other create files: add_citation(), add_compendium(), add_description(), add_license(), add_makefile(), add_readme_rmd(), add_testthat(), add_vignette()

Examples

1
2
3
4
## Not run: 
add_package_doc()

## End(Not run)

rcompendium documentation built on March 24, 2021, 5:06 p.m.