rdoc_options

rdoc_options-package

Rdoc uses the following <code>options()</code> to set output:<ul>
<li>`rdoc.by_section`: logical, output interactively printed by
sections for console sessions. Sections will be printed with the &lt;enter&gt;
keypress. Any other keypress will exit the interaction without printing the
remaining sections. Default is TRUE.</li>
<li>`rdoc.header`: logical, whether package header is included in the
output. Default is TRUE.</li>
<li>`rdoc.text_formats`: see <code><a rd-options="" href="/link/rdoc_text_formats?package=rdoc&version=0.1.0" data-mini-rdoc="rdoc::rdoc_text_formats">rdoc_text_formats</a></code></li>
<li>`rdoc.style`: see <code><a rd-options="" href="/link/rdoc_style?package=rdoc&version=0.1.0" data-mini-rdoc="rdoc::rdoc_style">rdoc_style</a></code></li>
<li>`rdoc.item_bullet`: Symbol to use for itemized lists. Default is
<code>paste0(cli::symbol$circle, " ")</code></li>
</ul>

Extends tools::Rd2txt() by adding customisable text and colour formatting to R documentation
contents. If used from a terminal, output will be displayed via file.show() otherwise contents
will be printed in sections. Also provides stand-in replacements for ?() and help().

Matthew de Queljoe

rdoc

Colourised R Documentation

rdoc_options function

Rdoc uses the following <code>options()</code> to set output:<ul>
<li>`rdoc.by_section`: logical, output interactively printed by
sections for console sessions. Sections will be printed with the &lt;enter&gt;
keypress. Any other keypress will exit the interaction without printing the
remaining sections. Default is TRUE.</li>
<li>`rdoc.header`: logical, whether package header is included in the
output. Default is TRUE.</li>
<li>`rdoc.text_formats`: see <code><a rd-options='' href='rdoc_text_formats'>rdoc_text_formats</a></code></li>
<li>`rdoc.style`: see <code><a rd-options='' href='rdoc_style'>rdoc_style</a></code></li>
<li>`rdoc.item_bullet`: Symbol to use for itemized lists. Default is
<code>paste0(cli::symbol$circle, " ")</code></li>
</ul>

rdoc_options: rdoc options

Description

Arguments