load_options

roxy_meta_get

base_path

Options can be stored in the <code>Roxygen</code> field of the <code>DESCRIPTION</code>, or
in <code>man/roxygen/meta.R</code>. In either case, the code is parsed and evaluated
in a child of the base environment. Call <code>roxy_meta_get()</code> to access
current option values from within tag and roclet methods.
Options in <code>man/roxygen/meta.R</code> override those present in <code>DESCRIPTION</code>.

internal

Generate your Rd documentation, 'NAMESPACE' file,
and collation field using specially formatted comments. Writing
documentation in-line with code makes it easier to keep your
documentation up-to-date as your requirements change. 'Roxygen2' is
inspired by the 'Doxygen' system for C++.

Hadley Wickham

roxygen2

In-Line Documentation for R

Peter Danenberg

G<c3><a1>bor Cs<c3><a1>rdi

Manuel Eugster

RStudio 

load_options function

<ul>
<li><code>roclets</code> <code>&lt;character&gt;</code>: giving names of roclets to run. See
<code><a rd-options="=roclet_find" href="/link/roclet_find()?package=roxygen2&version=7.1.2&to=%3Droclet_find" data-mini-rdoc="=roclet_find::roclet_find()">roclet_find()</a></code> for details.</li>
<li><code>packages</code> <code>&lt;character&gt;</code>: packages to load that implement new tags.</li>
<li><code>load</code> <code>&lt;string&gt;</code>: how to load R code. See <a rd-options="" href="/link/load?package=roxygen2&version=7.1.2" data-mini-rdoc="roxygen2::load">load</a> for details.</li>
<li><code>old_usage</code> <code>&lt;flag&gt;</code>: use old style usage formatting?</li>
<li><code>markdown</code> <code>&lt;flag&gt;</code>: translate markdown syntax to Rd?</li>
<li><code>r6</code> <code>&lt;flag&gt;</code>: document R6 classes?</li>
<li><code>current_package</code> <code>&lt;string&gt;</code> (read only): name of package being documented.</li>
<li><code>rd_family_title</code> <code>&lt;list&gt;</code>: overrides for <code>@family</code> titles. See the
rd vignette for details: <code>vignette("rd", package = "roxygen2")</code></li>
</ul>

Possible options

Either set in <code>DESCRIPTION</code>:<pre>Roxygen: list(markdown = TRUE, load = "installed")
</pre>Or if longer, you can put in <code>/man/roxygen/meta.R</code>:<pre>list(
 markdown = TRUE,
 load = "installed"
)
</pre>

How to set

Load roxygen2 options — load_options

Load roxygen2 options

load_options: Load roxygen2 options

Description

Usage

Arguments

Possible options

How to set