# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "rdocdump" in publications use:'
type: software
license: MIT
title: 'rdocdump: Dump ''R'' Package Source, Documentation, and Vignettes into One
  File'
version: 0.1.1
doi: 10.32614/CRAN.package.rdocdump
identifiers:
- type: doi
  value: 10.32614/CRAN.package.rdocdump
abstract: 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:
- family-names: Kotov
  given-names: Egor
  email: kotov.egor@gmail.com
  orcid: https://orcid.org/0000-0001-6690-5345
preferred-citation:
  type: manual
  title: 'rdocdump: Dump R Package Source, Documentation, and Vignettes into One File'
  authors:
  - family-names: Kotov
    given-names: Egor
    email: kotov.egor@gmail.com
    orcid: https://orcid.org/0000-0001-6690-5345
  year: '2025'
  url: https://github.com/e-kotov/rdocdump
  doi: 10.32614/CRAN.package.rdocdump
repository: https://CRAN.R-project.org/package=rdocdump
repository-code: https://github.com/e-kotov/rdocdump
url: https://www.ekotov.pro/rdocdump/
contact:
- family-names: Kotov
  given-names: Egor
  email: kotov.egor@gmail.com
  orcid: https://orcid.org/0000-0001-6690-5345
keywords:
- llm
- r-package
- rag
- text
references:
- type: software
  title: curl
  abstract: 'curl: A Modern and Flexible Web Client for R'
  notes: Suggests
  url: https://jeroen.r-universe.dev/curl
  repository: https://CRAN.R-project.org/package=curl
  authors:
  - family-names: Ooms
    given-names: Jeroen
    email: jeroenooms@gmail.com
    orcid: https://orcid.org/0000-0002-4035-0289
  year: '2025'
  doi: 10.32614/CRAN.package.curl
- type: software
  title: quarto
  abstract: 'quarto: R Interface to ''Quarto'' Markdown Publishing System'
  notes: Suggests
  url: https://quarto-dev.github.io/quarto-r/
  repository: https://CRAN.R-project.org/package=quarto
  authors:
  - family-names: Allaire
    given-names: JJ
    email: jj@posit.co
    orcid: https://orcid.org/0000-0003-0174-9868
  - family-names: Dervieux
    given-names: Christophe
    email: cderv@posit.co
    orcid: https://orcid.org/0000-0003-4474-2498
  year: '2025'
  doi: 10.32614/CRAN.package.quarto
- type: software
  title: testthat
  abstract: 'testthat: Unit Testing for R'
  notes: Suggests
  url: https://testthat.r-lib.org
  repository: https://CRAN.R-project.org/package=testthat
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.testthat
  version: '>= 3.0.0'
- type: software
  title: withr
  abstract: 'withr: Run Code ''With'' Temporarily Modified Global State'
  notes: Suggests
  url: https://withr.r-lib.org
  repository: https://CRAN.R-project.org/package=withr
  authors:
  - family-names: Hester
    given-names: Jim
  - family-names: Henry
    given-names: Lionel
    email: lionel@posit.co
  - family-names: Müller
    given-names: Kirill
    email: krlmlr+r@mailbox.org
  - family-names: Ushey
    given-names: Kevin
    email: kevinushey@gmail.com
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  - family-names: Chang
    given-names: Winston
  year: '2025'
  doi: 10.32614/CRAN.package.withr

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "rdocdump",
  "description": "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.",
  "name": "rdocdump: Dump 'R' Package Source, Documentation, and Vignettes into One File",
  "relatedLink": [
    "https://www.ekotov.pro/rdocdump/",
    "https://CRAN.R-project.org/package=rdocdump"
  ],
  "codeRepository": "https://github.com/e-kotov/rdocdump",
  "issueTracker": "https://github.com/e-kotov/rdocdump/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.1.1",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.1 (2025-06-13)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Egor",
      "familyName": "Kotov",
      "email": "kotov.egor@gmail.com",
      "@id": "https://orcid.org/0000-0001-6690-5345"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Egor",
      "familyName": "Kotov",
      "email": "kotov.egor@gmail.com",
      "@id": "https://orcid.org/0000-0001-6690-5345"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Egor",
      "familyName": "Kotov",
      "email": "kotov.egor@gmail.com",
      "@id": "https://orcid.org/0000-0001-6690-5345"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "curl",
      "name": "curl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=curl"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "quarto",
      "name": "quarto",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=quarto"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "withr",
      "name": "withr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=withr"
    }
  ],
  "softwareRequirements": {
    "SystemRequirements": null
  },
  "fileSize": "80.824KB",
  "citation": [
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2025",
      "author": [
        {
          "@type": "Person",
          "givenName": "Egor",
          "familyName": "Kotov",
          "email": "kotov.egor@gmail.com",
          "@id": "https://orcid.org/0000-0001-6690-5345"
        }
      ],
      "name": "rdocdump: Dump R Package Source, Documentation, and Vignettes into One File",
      "identifier": "10.32614/CRAN.package.rdocdump",
      "url": "https://github.com/e-kotov/rdocdump",
      "@id": "https://doi.org/10.32614/CRAN.package.rdocdump",
      "sameAs": "https://doi.org/10.32614/CRAN.package.rdocdump"
    }
  ],
  "releaseNotes": "https://github.com/e-kotov/rdocdump/blob/master/NEWS.md",
  "readme": "https://github.com/e-kotov/rdocdump/blob/main/README.md",
  "contIntegration": [
    "https://github.com/e-kotov/rdocdump/actions/workflows/R-CMD-check.yaml",
    "https://github.com/e-kotov/rdocdump/actions?query=workflow%3Apkgcheck"
  ],
  "developmentStatus": [
    "https://www.repostatus.org/#active",
    "https://lifecycle.r-lib.org/articles/stages.html#experimental"
  ],
  "keywords": [
    "llm",
    "r-package",
    "rag",
    "text"
  ]
}