update_docstring

The <a href="https://roxygen2.r-lib.org/">roxygen2</a> package makes it
possible to write documentation for R functions directly above the
corresponding function. This function can be used to update the parameter
list of a documentation string (docstring) of a valid function of a valid R
file. The update is done by comparing the currently listed parameters with
the actual function parameters. Outdated parameters are removed and missing
parameters are added to the docstring.

Base R sometimes requires verbose statements for simple,
often recurring tasks, such as printing text without trailing
space, ending with newline. This package aims at providing
shorthands for such tasks.

Tobias Schmidt

toscutil

Utility Functions

update_docstring function

<dl><dt>uri</dt>
<dd>Path to R file.</dd>
<dt>func</dt>
<dd>Function name. If a function is defined multiple times inside the
provided file, only the last occurence will be considered.</dd>
<dt>content</dt>
<dd>R code as string. If provided, uri is ignored.</dd></dl>

Arguments

The <a href='https://roxygen2.r-lib.org/'>roxygen2</a> package makes it
possible to write documentation for R functions directly above the
corresponding function. This function can be used to update the parameter
list of a documentation string (docstring) of a valid function of a valid R
file. The update is done by comparing the currently listed parameters with
the actual function parameters. Outdated parameters are removed and missing
parameters are added to the docstring.

Update docstring for a Function — update_docstring

<dl>

<dt>uri</dt>
<dd>Path to R file.</dd>


<dt>func</dt>
<dd>Function name. If a function is defined multiple times inside the
provided file, only the last occurence will be considered.</dd>


<dt>content</dt>
<dd>R code as string. If provided, uri is ignored.</dd>

</dl>

update_docstring: Update docstring for a Function

Description

Usage

Value

Arguments

Examples