fake_package

To build documentation for a single code file, we need a temporary package.
Of course the code file should contain roxygen2 comments.

internal

Have you ever been tempted to create 'roxygen2'-style documentation
comments for one of your functions that was not part of one of your
packages (yet)?
This is exactly what this package is about: running 'roxygen2' on
(chunks of) a single code file.

Andreas Dominik Cullmann

document

Run 'roxygen2' on (Chunks of) Single Code Files

fake_package function

<dl><dt>file_name</dt>
<dd>The name of the R code file to be documented.</dd>
<dt>working_directory</dt>
<dd>A working directory. Keep the default.</dd>
<dt>dependencies</dt>
<dd>A character vector of package names the functions depend
on.</dd>
<dt>...</dt>
<dd>Arguments passed to
<code>get_lines_between_tags</code>.</dd></dl>

Arguments

Fake a Package From a Single Code File — fake_package

<dl>

<dt>file_name</dt>
<dd>The name of the R code file to be documented.</dd>


<dt>working_directory</dt>
<dd>A working directory. Keep the default.</dd>


<dt>dependencies</dt>
<dd>A character vector of package names the functions depend
on.</dd>


<dt>...</dt>
<dd>Arguments passed to
<code>get_lines_between_tags</code>.</dd>

</dl>

fake_package: Fake a Package From a Single Code File

Description

Usage

Value

Arguments