combine_rd

Combine Rd files into a single character vector.
This function reads the Rd files from a package source directory or an installed package and combines them into a single string.

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

combine_rd function

<dl><dt>pkg_path</dt>
<dd>Path to the package source directory or the installed package.</dd>
<dt>is_installed</dt>
<dd>Logical indicating whether the package is installed (<code>TRUE</code>) or a source package (<code>FALSE</code>).</dd>
<dt>pkg_name</dt>
<dd>Optional package name if the package is installed.</dd></dl>

Arguments

Combine Rd files into a single character vector.
This function reads the Rd files from a package source directory or an installed package and combines them into a single string. — combine_rd

<dl>

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


<dt>is_installed</dt>
<dd>Logical indicating whether the package is installed (<code>TRUE</code>) or a source package (<code>FALSE</code>).</dd>


<dt>pkg_name</dt>
<dd>Optional package name if the package is installed.</dd>

</dl>

Combine Rd files into a single character vector.
This function reads the Rd files from a package source directory or an installed package and combines them into a single string.

combine_rd: Combine Rd files into a single character vector. This function reads the Rd files from a package source directory or an installed package and combines them into a single string.

Description

Usage

Value

Arguments