Introduction | Installation | Setting the Cache Path | Extracting Documentation | Choosing what to dump to text | Handling Temporary Files
Package: rdocdump 0.3.0
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.
Authors:
rdocdump_0.3.0.tar.gz
rdocdump_0.3.0.zip(r-4.7)rdocdump_0.3.0.zip(r-4.6)rdocdump_0.3.0.zip(r-4.5)
rdocdump_0.3.0.tgz(r-4.6-any)rdocdump_0.3.0.tgz(r-4.5-any)
rdocdump_0.3.0.tar.gz(r-4.7-any)rdocdump_0.3.0.tar.gz(r-4.6-any)
rdocdump_0.3.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
rdocdump/json (API)
| # Install 'rdocdump' in R: |
| install.packages('rdocdump', repos = c('https://e-kotov.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/e-kotov/rdocdump/issues
Pkgdown/docs site:https://www.ekotov.pro
Last updated from:c4150af9f6. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 154 | ||
| source / vignettes | OK | 151 | ||
| linux-release-x86_64 | OK | 190 | ||
| macos-release-arm64 | OK | 140 | ||
| macos-oldrel-arm64 | OK | 114 | ||
| windows-devel | OK | 118 | ||
| windows-release | OK | 140 | ||
| windows-oldrel | OK | 134 | ||
| wasm-release | OK | 129 |
Exports:rdd_extract_coderdd_get_reposrdd_set_cache_pathrdd_set_reposrdd_to_txt
Dependencies:
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Extract R Source Code from a Package | rdd_extract_code |
| Get Current 'rdocdump' Repository Options | rdd_get_repos |
| Set 'rdocdump' Cache Path in the Current R Session | rdd_set_cache_path |
| Set 'rdocdump' Repository Options | rdd_set_repos |
| Dump Package Source, Documentation and Vignettes into Plain Text | rdd_to_txt |
