cleanup_files

Clean up temporary package archive and extracted files according to a keep_files policy.

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

cleanup_files function

<dl><dt>pkg_info</dt>
<dd>A list returned by <code>resolve_pkg_path()</code>, containing <code>tar_path</code> and <code>extracted_path</code>.</dd>
<dt>keep_files</dt>
<dd>A <code>character</code> value controlling whether temporary files should be kept.
Possible values are:<ul>
<li><code>"none"</code>: Delete both the tar.gz archive and the extracted files (default).</li>
<li><code>"tgz"</code>: Keep only the tar.gz archive.</li>
<li><code>"extracted"</code>: Keep only the extracted files.</li>
<li><code>"both"</code>: Keep both the tar.gz archive and the extracted files.</li>
</ul></dd></dl>

Arguments

Cleanup Temporary Files — cleanup_files

<dl>

<dt>pkg_info</dt>
<dd>A list returned by <code>resolve_pkg_path()</code>, containing <code>tar_path</code> and <code>extracted_path</code>.</dd>


<dt>keep_files</dt>
<dd>A <code>character</code> value controlling whether temporary files should be kept.
Possible values are:<ul>
<li><code>"none"</code>: Delete both the tar.gz archive and the extracted files (default).</li>
<li><code>"tgz"</code>: Keep only the tar.gz archive.</li>
<li><code>"extracted"</code>: Keep only the extracted files.</li>
<li><code>"both"</code>: Keep both the tar.gz archive and the extracted files.</li>
</ul></dd>

</dl>

cleanup_files: Cleanup Temporary Files

Description

Usage

Value

Arguments