add_github_actions_document: Setup GitHub Actions to document package

In rcompendium: Create a Package or Research Compendium Structure

Setup GitHub Actions to document package

Description

This function creates a configuration file (.yaml) to setup GitHub Actions to document the package and update the Rd files in the ⁠man/⁠, the NAMESPACE and DESCRIPTION files. This workflow is derived from https://github.com/r-lib/actions/tree/v2-branch/examples. This file will be written as .github/workflows/document-package.yaml.

Usage

add_github_actions_document(open = FALSE, 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

No return value.

See Also

Other development functions: add_dependencies(), add_github_actions_check(), add_github_actions_citation(), add_github_actions_codecov(), add_github_actions_pkgdown(), add_github_actions_render(), add_r_depend(), add_to_buildignore(), add_to_gitignore()

Examples

## Not run: 
add_github_actions_document()

## End(Not run)

rcompendium documentation built on Oct. 26, 2023, 5:08 p.m.