rdocdump: Dump 'R' Package Source, Documentation, and Vignettes into One File
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.
| Version: | 0.1.0 |
| Suggests: | curl, quarto, testthat (≥ 3.0.0), withr |
| Published: | 2025-06-18 |
| DOI: | 10.32614/CRAN.package.rdocdump |
| Author: | Egor Kotov  [aut,
cre, cph] |
| Maintainer: | Egor Kotov <kotov.egor at gmail.com> |
| BugReports: | https://github.com/e-kotov/rdocdump/issues |
| License: | MIT + file LICENSE |
| URL: | https://github.com/e-kotov/rdocdump, https://www.ekotov.pro/rdocdump/ |
| NeedsCompilation: | no |
| Language: | en |
| Citation: | rdocdump citation info |
| Materials: | README NEWS |
| CRAN checks: | rdocdump results |
Documentation:
| Reference manual: | rdocdump.pdf |
| Vignettes: |
Quick Start: dump R docs and vignettes to text files for LLMs (source) |
Downloads:
| Package source: | rdocdump_0.1.0.tar.gz |
| Windows binaries: | r-devel: rdocdump_0.1.0.zip, r-release: not available, r-oldrel: rdocdump_0.1.0.zip |
| macOS binaries: | r-release (arm64): rdocdump_0.1.0.tgz, r-oldrel (arm64): rdocdump_0.1.0.tgz, r-release (x86_64): rdocdump_0.1.0.tgz, r-oldrel (x86_64): rdocdump_0.1.0.tgz |
Linking:
Please use the canonical form https://CRAN.R-project.org/package=rdocdump to link to this page.