add_github_actions_pkgdown_badge

This function adds a Website badge to the <code>README.Rmd</code>. This function
must be run after <code>add_github_actions_pkgdown()</code> which will setup
GitHub Actions to build and deploy the package website.
Make sure that 1) a <code>README.Rmd</code> file exists at the project root and 2) it
contains a block starting with the line <code>&lt;!-- badges: start --&gt;</code> and ending
with the line <code>&lt;!-- badges: end --&gt;</code>.
Don't forget to re-render the <code>README.md</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_pkgdown_badge function

<dl><dt>organisation</dt>
<dd>A character of length 1. The name of the GitHub
organisation to host the package. If <code>NULL</code> (default) the GitHub account
will be used.</dd>
<dt>quiet</dt>
<dd>A logical value. If <code>TRUE</code> messages are deleted. Default is
<code>FALSE</code>.</dd></dl>

Arguments

Add a Website badge — add_github_actions_pkgdown_badge

<dl>

<dt>organisation</dt>
<dd>A character of length 1. The name of the GitHub
organisation to host the package. If <code>NULL</code> (default) the GitHub account
will be used.</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_pkgdown_badge: Add a Website badge

Description

Usage

Value

Arguments

See Also

Examples