get_lines_between_tags

Get all lines between tagged lines. The tagged lines themselves may be in- or
excluded from the selection.

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

get_lines_between_tags function

<dl><dt>file_name</dt>
<dd>The name of the R code file to be parsed.</dd>
<dt>keep_tagged_lines</dt>
<dd>Keep tagged lines output?</dd>
<dt>begin_pattern</dt>
<dd>A pattern that marks the line beginning a
roxygen2
chunk.</dd>
<dt>end_pattern</dt>
<dd>A pattern that marks the line ending a roxygen2
chunk.</dd>
<dt>from_first_line</dt>
<dd>Use first line as tagged line if first tag found
matches the <code>end_pattern</code>?</dd>
<dt>to_last_line</dt>
<dd>Use last line as tagged line if last tag found matches
the <code>begin_pattern</code>?</dd></dl>

Arguments

Cut Code Chunks From a File — get_lines_between_tags

<dl>

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


<dt>keep_tagged_lines</dt>
<dd>Keep tagged lines output?</dd>


<dt>begin_pattern</dt>
<dd>A pattern that marks the line beginning a
roxygen2
chunk.</dd>


<dt>end_pattern</dt>
<dd>A pattern that marks the line ending a roxygen2
chunk.</dd>


<dt>from_first_line</dt>
<dd>Use first line as tagged line if first tag found
matches the <code>end_pattern</code>?</dd>


<dt>to_last_line</dt>
<dd>Use last line as tagged line if last tag found matches
the <code>begin_pattern</code>?</dd>

</dl>

get_lines_between_tags: Cut Code Chunks From a File

Description

Usage

Value

Arguments