add_github_actions_document

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

Makes easier the creation of R package or research compendium
(i.e. a predefined files/folders structure) so that users can focus on the
code/analysis instead of wasting time organizing files. A full
ready-to-work structure is set up with some additional features: version
control, remote repository creation, CI/CD configuration (check package
integrity under several OS, test code with 'testthat', and build and deploy
website using 'pkgdown'). This package heavily relies on the R packages
'devtools' and 'usethis' and follows recommendations made by Wickham H.
(2015) <ISBN:9781491910597> and Marwick B. et al. (2018)
<doi:10.7287/peerj.preprints.3192v2>.

Nicolas Casajus

rcompendium

Create a Package or Research Compendium Structure

add_github_actions_document function

<dl><dt>open</dt>
<dd>A logical value. If <code>TRUE</code> (default) the file is opened in the
editor.</dd>
<dt>overwrite</dt>
<dd>A logical value. If this file is already present and
<code>overwrite = TRUE</code>, it will be erased and replaced. Default is <code>FALSE</code>.</dd>
<dt>quiet</dt>
<dd>A logical value. If <code>TRUE</code> messages are deleted. Default is
<code>FALSE</code>.</dd></dl>

Arguments

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

Setup GitHub Actions to document package — add_github_actions_document

<dl>

<dt>open</dt>
<dd>A logical value. If <code>TRUE</code> (default) the file is opened in the
editor.</dd>


<dt>overwrite</dt>
<dd>A logical value. If this file is already present and
<code>overwrite = TRUE</code>, it will be erased and replaced. Default is <code>FALSE</code>.</dd>


<dt>quiet</dt>
<dd>A logical value. If <code>TRUE</code> messages are deleted. Default is
<code>FALSE</code>.</dd>

</dl>

add_github_actions_document: Setup GitHub Actions to document package

Description

Usage

Value

Arguments

See Also

Examples