check_docs

Performs a series of documentation consistency checks on a package
using roxygen2 parsed blocks.
The following checks are performed:<ul>
<li>Missing <code>@examples</code> tag in exported functions</li>
<li>Missing example content</li>
<li>Missing <code>@title</code></li>
<li>Usage of discouraged <code>@describeIn</code></li>
<li>Usage of deprecated <code>@return</code></li>
<li>Missing <code>@returns</code></li>
</ul>

Helps to prepare a release. Before releasing an R package it is important to update the DESCRIPTION file and the changelog. This package prepares these files and also updates the versions according to the branches. It relies heavily on the 'desc' packages.

Tanguy Barthelemy

releaser

Help with Preparing a New Version of an R Package

check_docs function

<dl><dt>pkg_dir</dt>
<dd>Path to the R package.</dd>
<dt>verbose</dt>
<dd>Logical. If <code>TRUE</code>, prints a formatted summary.</dd>
<dt>error_on_fail</dt>
<dd>Logical. If <code>TRUE</code>, stops execution if any issue is
found.</dd></dl>

Arguments

Check R package documentation — check_docs

<dl>

<dt>pkg_dir</dt>
<dd>Path to the R package.</dd>


<dt>verbose</dt>
<dd>Logical. If <code>TRUE</code>, prints a formatted summary.</dd>


<dt>error_on_fail</dt>
<dd>Logical. If <code>TRUE</code>, stops execution if any issue is
found.</dd>

</dl>

check_docs: Check R package documentation

Description

Usage

Value

Arguments