add_license

This function adds a license to the project. It will add the license name
in the <code>License</code> field of the <code>DESCRIPTION</code> file and write the content of
the license in the <code>License.md</code> file.

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_license function

<dl><dt>license</dt>
<dd>A character of length 1. The chosen license.
Run <code>get_licenses()</code>) to select an appropriate one.</dd>
<dt>given</dt>
<dd>A character of length 1. The given name of the copyright holder.
Only required if <code>license = 'MIT'</code>. If is <code>NULL</code> (default) and
<code>license = 'MIT'</code>, this function will try to retrieve the value of this
parameter from the <code>.Rprofile</code> file (edited with <code>set_credentials()</code>).</dd>
<dt>family</dt>
<dd>A character of length 1. The family name of the copyright
holder. Only required if <code>license = 'MIT'</code>. If is <code>NULL</code> (default) and
<code>license = 'MIT'</code>, this function will try to retrieve the value of this
parameter from the <code>.Rprofile</code> file (edited with <code>set_credentials()</code>).</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 LICENSE — add_license

<dl>

<dt>license</dt>
<dd>A character of length 1. The chosen license.
Run <code>get_licenses()</code>) to select an appropriate one.</dd>


<dt>given</dt>
<dd>A character of length 1. The given name of the copyright holder.
Only required if <code>license = 'MIT'</code>. If is <code>NULL</code> (default) and
<code>license = 'MIT'</code>, this function will try to retrieve the value of this
parameter from the <code>.Rprofile</code> file (edited with <code>set_credentials()</code>).</dd>


<dt>family</dt>
<dd>A character of length 1. The family name of the copyright
holder. Only required if <code>license = 'MIT'</code>. If is <code>NULL</code> (default) and
<code>license = 'MIT'</code>, this function will try to retrieve the value of this
parameter from the <code>.Rprofile</code> file (edited with <code>set_credentials()</code>).</dd>


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

</dl>

add_license: Add a LICENSE

Description

Usage

Value

Arguments

See Also

Examples