rcompendium (version 1.3)

add_package_doc: Create a package-level documentation file

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

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

Value

No return value.

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.

See Also

Other create files: add_citation(), add_code_of_conduct(), add_compendium(), add_contributing(), add_description(), add_dockerfile(), add_license(), add_makefile(), add_readme_rmd(), add_renv(), add_testthat(), add_vignette()

Examples

if (FALSE) {
add_package_doc()
}