extract_code_source

Helper function to extract code from package source files.
This function reads all <code>.R</code> files in the <code>R</code> directory and optionally includes files from the <code>tests</code> directory.
It can also exclude roxygen2 documentation lines.

internal

Dump source code, documentation and vignettes of an 'R'
package into a single file. Supports installed packages, tar.gz
archives, and package source directories. If the package is not
installed, only its source is automatically downloaded from CRAN for
processing. The output is a single plain text file or a character
vector, which is useful to ingest complete package documentation and
source into a large language model (LLM) or pass it further to other
tools, such as 'ragnar' <https://github.com/tidyverse/ragnar> to
create a Retrieval-Augmented Generation (RAG) workflow.

Egor Kotov

rdocdump

Dump 'R' Package Source, Documentation, and Vignettes into One
File

extract_code_source function

<dl><dt>pkg_path</dt>
<dd>Path to the package source directory.</dd>
<dt>include_tests</dt>
<dd><code>logical</code>. If <code>TRUE</code>, for non-installed packages, the function will also include R source code from the <code>tests</code> directory. Defaults to <code>FALSE</code>.</dd>
<dt>include_roxygen</dt>
<dd><code>logical</code>. If <code>TRUE</code>, roxygen2 documentation lines (lines starting with "#'") from R files will be included in the output. Defaults to <code>FALSE</code>.</dd></dl>

Arguments

Helper function to extract code from package source files.
This function reads all .R files in the R directory and optionally includes files from the tests directory.
It can also exclude roxygen2 documentation lines. — extract_code_source

<dl>

<dt>pkg_path</dt>
<dd>Path to the package source directory.</dd>


<dt>include_tests</dt>
<dd><code>logical</code>. If <code>TRUE</code>, for non-installed packages, the function will also include R source code from the <code>tests</code> directory. Defaults to <code>FALSE</code>.</dd>


<dt>include_roxygen</dt>
<dd><code>logical</code>. If <code>TRUE</code>, roxygen2 documentation lines (lines starting with "#'") from R files will be included in the output. Defaults to <code>FALSE</code>.</dd>

</dl>

Helper function to extract code from package source files.
This function reads all <code>.R</code> files in the <code>R</code> directory and optionally includes files from the <code>tests</code> directory.
It can also exclude roxygen2 documentation lines.

extract_code_source: Helper function to extract code from package source files. This function reads all `.R` files in the `R` directory and optionally includes files from the `tests` directory. It can also exclude roxygen2 documentation lines.

Description

Usage

Value

Arguments