parse_package

parse_file

parse_text

env_file

env_package

<code>parse_package()</code>, <code>parse_file()</code>, and <code>parse_text()</code> allow you to use
roxygen's parsing code to parse the roxygen blocks from a package, file, or
character vector of code. <code>env_package()</code> and <code>env_file()</code> provide
defaults that generate a temporary environment making it possible to
associate each block with the corresponding live object.

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ábor Csárdi

Manuel Eugster

Posit Software, PBC 

parse_package function

<dl><dt>path, file, text</dt>
<dd>Either specify a <code>path</code> to the root directory of
a package, an R <code>file</code>, or a character vector <code>text</code>.</dd>
<dt>env</dt>
<dd>An environment environment containing the result of evaluating
the input code. The defaults will do this for you in a test environment:
for real code you'll need to generate the environment yourself.
You can also set to <code>NULL</code> if you only want to get the tokenized code
blocks only. This suppresses evaluation of <code>@eval</code> tags, and will not
find the code object associated with each block.</dd></dl>

Arguments

Parse a package, file, or inline code — parse_package

<dl>

<dt>path, file, text</dt>
<dd>Either specify a <code>path</code> to the root directory of
a package, an R <code>file</code>, or a character vector <code>text</code>.</dd>


<dt>env</dt>
<dd>An environment environment containing the result of evaluating
the input code. The defaults will do this for you in a test environment:
for real code you'll need to generate the environment yourself.
You can also set to <code>NULL</code> if you only want to get the tokenized code
blocks only. This suppresses evaluation of <code>@eval</code> tags, and will not
find the code object associated with each block.</dd>

</dl>

Parse a package, file, or inline code

parse_package: Parse a package, file, or inline code

Description

Usage

Value

Arguments