README.qmd

---
format: gfm
eval: false
default-image-extension: ""
---

<!-- README.md is generated from README.Rmd. Please edit that file -->


# rdocdump: Dump 'R' Package Source, Documentation, and Vignettes into One File <a href="https://www.ekotov.pro/rdocdump/"><img src="man/figures/logo.png" align="right" width="200" alt="rdocdump website" /></a>

<!-- badges: start -->
[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![CRAN status](https://www.r-pkg.org/badges/version/rdocdump)](https://CRAN.R-project.org/package=rdocdump)
[![CRAN/METACRAN Total downloads](https://cranlogs.r-pkg.org/badges/grand-total/rdocdump?color=blue)](https://CRAN.R-project.org/package=rdocdump){target="_blank"}
[![CRAN/METACRAN Downloads per month](https://cranlogs.r-pkg.org/badges/rdocdump?color=blue)](https://CRAN.R-project.org/package=rdocdump){target="_blank"}
[![R-CMD-check](https://github.com/e-kotov/rdocdump/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/e-kotov/rdocdump/actions/workflows/R-CMD-check.yaml)
[![pkgcheck](https://github.com/e-kotov/rdocdump/workflows/pkgcheck/badge.svg)](https://github.com/e-kotov/rdocdump/actions?query=workflow%3Apkgcheck)

[![DOI](https://zenodo.org/badge/DOI/10.32614/CRAN.package.rdocdump.svg)](https://doi.org/10.32614/CRAN.package.rdocdump)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15072446.svg)](https://doi.org/10.5281/zenodo.15072446)
<!-- badges: end -->

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){target='_blank'} to create a Retrieval-Augmented Generation (RAG) workflow.

## Installation

Install the latest stable release of `rdocdump` from CRAN with:

```r
install.packages("rdocdump")
```

You can install the development version of `rdocdump` from R Universe with:

```r
install.packages('rdocdump',
 repos = c('https://e-kotov.r-universe.dev', 'https://cloud.r-project.org')
)
```

or from GitHub with:

```r
# install.packages("pak")
pak::pak("e-kotov/rdocdump")
```



## Example

Extract documenation and source code of `{rJavaEnv}` package by downloading source from CRAN and save it to file `rJavaEnv_docs.txt`

```r
rdd_to_txt(
  pkg = "rJavaEnv",
  file = tempfile("rJavaEnv_docs_", fileext = ".txt"),
  force_fetch = TRUE, # force download even if package is installed
  keep_files = "none" # delete temp files
)
```


## Citation

```{r}
#| eval: true
#| echo: false
#| results: 'asis'
print(citation("rdocdump"), bibtex = FALSE)
```

BibTeX:
```
```{r}
#| eval: true
#| echo: false
#| results: 'asis'
toBibtex(citation("rdocdump"))
```
```