style_roxygen_code_example_one

Style a roxygen code example with exactly one <code>@example</code> or <code>@exampleIf</code>

internal

Pretty-prints R code without changing the user's formatting
intent.

Lorenz Walthert

styler

Non-Invasive Pretty Printing of R Code

Kirill Müller

Indrajeet Patil

style_roxygen_code_example_one function

<dl><dt>example_one</dt>
<dd>A character vector, one element per line, that contains in
total at most one example tag.</dd>
<dt>transformers</dt>
<dd>Passed to <code>cache_make_key()</code> to generate a key.</dd>
<dt>base_indention</dt>
<dd>Integer scalar indicating by how many spaces the whole
output text should be indented. Note that this is not the same as splitting
by line and add a <code>base_indention</code> spaces before the code in the case
multi-line strings are present. See 'Examples'.</dd></dl>

Arguments

Style a roxygen code example with exactly one @example or @exampleIf — style_roxygen_code_example_one

<dl>

<dt>example_one</dt>
<dd>A character vector, one element per line, that contains in
total at most one example tag.</dd>


<dt>transformers</dt>
<dd>Passed to <code>cache_make_key()</code> to generate a key.</dd>


<dt>base_indention</dt>
<dd>Integer scalar indicating by how many spaces the whole
output text should be indented. Note that this is not the same as splitting
by line and add a <code>base_indention</code> spaces before the code in the case
multi-line strings are present. See 'Examples'.</dd>

</dl>

style_roxygen_code_example_one: Style a roxygen code example with exactly one `@example` or `@exampleIf`

Description

Usage

Arguments