linters

lint_starts_lowercase

lint_full_stop

lint_no_full_stop

lint_sentence_case

lint_title_case

tidy_title

tidy_param

tidy_return

tidy_seealso

tidy

Preconfigured linters, either as a collective list of linters or
individually. "tidy" linters implement guidelines from the tidyverse style
guide.

datasets

Provides formatting linting to 'roxygen2' tags. Linters report
'roxygen2' tags that do not conform to a standard style. These linters
can be a helpful check for building more consistent documentation and
to provide reminders about best practices or checks for typos. Default
linting suites are provided for common style guides such as the one
followed by the 'tidyverse', though custom linters can be registered by
other packages or be custom-tailored to a specific package.

Doug Kelkhoff

roxylint

Lint 'roxygen2'-Generated Documentation

linters function

An object of class <code>list</code> of length 4.

Format

<dl><dt>x</dt>
<dd>A <code><a href="https://roxygen2.r-lib.org/reference/roxy_tag.html">roxygen2::roxy_tag()</a></code> that is the subject of linting.</dd>
<dt>...</dt>
<dd>Additional arguments unused.</dd>
<dt>name, description</dt>
<dd>Used for <code><a href="https://roxygen2.r-lib.org/reference/roxy_tag.html">roxygen2::roxy_tag()</a></code>-specific linters.</dd></dl>

Arguments

<ul>
<li><code>lint_starts_lowercase()</code>: Lowercase start linting. (uses <code>$raw</code> for <code><a href="https://roxygen2.r-lib.org/reference/roxy_tag.html">roxygen2::roxy_tag()</a></code>s)</li>
<li><code>lint_full_stop()</code>: Ends in a full stop. (uses <code>$raw</code> for <code><a href="https://roxygen2.r-lib.org/reference/roxy_tag.html">roxygen2::roxy_tag()</a></code>s)</li>
<li><code>lint_no_full_stop()</code>: Does not end in a full stop. (uses <code>$raw</code> for <code><a href="https://roxygen2.r-lib.org/reference/roxy_tag.html">roxygen2::roxy_tag()</a></code>s)</li>
<li><code>lint_sentence_case()</code>: Sentence case linting (uses <code>$raw</code> for <code><a href="https://roxygen2.r-lib.org/reference/roxy_tag.html">roxygen2::roxy_tag()</a></code>s)</li>
<li><code>lint_title_case()</code>: Title case linting</li>
<li><code>tidy_title()</code>: Tidy 'Sentence case' titles</li>
<li><code>tidy_param()</code>: Tidy 'Sentence case' <code>@param</code> definitions</li>
<li><code>tidy_return()</code>: Tidy 'Sentence case' <code>@return</code> definitions</li>
<li><code>tidy_seealso()</code>: Tidy 'Sentence case' <code>@seealso</code> definitions</li>
<li><code>tidy</code>: A list of all tidyverse style guide inspired linters</li>
</ul>

Functions

Assorted linters — linters

<dl>

<dt>x</dt>
<dd>A <code><a href='https://roxygen2.r-lib.org/reference/roxy_tag.html'>roxygen2::roxy_tag()</a></code> that is the subject of linting.</dd>


<dt>...</dt>
<dd>Additional arguments unused.</dd>


<dt>name, description</dt>
<dd>Used for <code><a href='https://roxygen2.r-lib.org/reference/roxy_tag.html'>roxygen2::roxy_tag()</a></code>-specific linters.</dd>

</dl>

<ul>
<li><code>lint_starts_lowercase()</code>: Lowercase start linting. (uses <code>$raw</code> for <code><a href='https://roxygen2.r-lib.org/reference/roxy_tag.html'>roxygen2::roxy_tag()</a></code>s)</li>
<li><code>lint_full_stop()</code>: Ends in a full stop. (uses <code>$raw</code> for <code><a href='https://roxygen2.r-lib.org/reference/roxy_tag.html'>roxygen2::roxy_tag()</a></code>s)</li>
<li><code>lint_no_full_stop()</code>: Does not end in a full stop. (uses <code>$raw</code> for <code><a href='https://roxygen2.r-lib.org/reference/roxy_tag.html'>roxygen2::roxy_tag()</a></code>s)</li>
<li><code>lint_sentence_case()</code>: Sentence case linting (uses <code>$raw</code> for <code><a href='https://roxygen2.r-lib.org/reference/roxy_tag.html'>roxygen2::roxy_tag()</a></code>s)</li>
<li><code>lint_title_case()</code>: Title case linting</li>
<li><code>tidy_title()</code>: Tidy 'Sentence case' titles</li>
<li><code>tidy_param()</code>: Tidy 'Sentence case' <code>@param</code> definitions</li>
<li><code>tidy_return()</code>: Tidy 'Sentence case' <code>@return</code> definitions</li>
<li><code>tidy_seealso()</code>: Tidy 'Sentence case' <code>@seealso</code> definitions</li>
<li><code>tidy</code>: A list of all tidyverse style guide inspired linters</li>
</ul>

linters: Assorted linters

Description

Usage

Format

Arguments

Functions

Details