{
  "_id": "6aea8d5d818c9e3ef6dc0562",
  "Package": "document",
  "Title": "Run 'roxygen2' on (Chunks of) Single Code Files",
  "Version": "4.0.1.9000",
  "Authors@R": "person(given = c(\"Andreas\", \"Dominik\"), family = \"Cullmann\",\nemail = \"fvafrcu@mailbox.org\", role = c(\"aut\",\"cre\"))",
  "Description": "Have you ever been tempted to create 'roxygen2'-style\ndocumentation comments for one of your functions that was not\npart of one of your packages (yet)? This is exactly what this\npackage is about: running 'roxygen2' on (chunks of) a single\ncode file.",
  "License": "BSD_2_clause + file LICENSE",
  "URL": "https://gitlab.com/fvafrcu/document",
  "Encoding": "UTF-8",
  "VignetteBuilder": "knitr",
  "RoxygenNote": "7.3.2",
  "Config/pak/sysreqs": "cmake make libuv1-dev libxml2-dev libssl-dev",
  "Repository": "https://fvafrcu.r-universe.dev",
  "Date/Publication": "2025-05-25 10:36:46 UTC",
  "RemoteUrl": "https://gitlab.com/fvafrcu/document",
  "RemoteRef": "HEAD",
  "RemoteSha": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
  "NeedsCompilation": "no",
  "Packaged": {
    "Date": "2026-11-04 01:39:09 UTC",
    "User": "root"
  },
  "Author": "Andreas Dominik Cullmann [aut, cre]",
  "Maintainer": "Andreas Dominik Cullmann <fvafrcu@mailbox.org>",
  "_user": "fvafrcu",
  "_type": "src",
  "_file": "document_4.0.1.9000.tar.gz",
  "_fileid": "https://r2.ropensci.org/6bfc5bf70710aa6ea7859faa9e8c063c15ca1051dec90dbb6f21f136dc7416d8",
  "_filesize": 137852,
  "_sha256": "6bfc5bf70710aa6ea7859faa9e8c063c15ca1051dec90dbb6f21f136dc7416d8",
  "_expires": "2027-02-12T01:41:48.000Z",
  "_created": "2026-11-04T01:39:09.000Z",
  "_published": "2026-11-04T01:41:49.844Z",
  "_upstream": "https://gitlab.com/fvafrcu/document",
  "_status": "success",
  "_maintainer": {
    "name": "Andreas Dominik Cullmann",
    "email": "fvafrcu@mailbox.org",
    "login": "fvafrcu",
    "description": "",
    "uuid": 10984039
  },
  "_jobs": [
    {
      "job": 126330654764,
      "time": 119,
      "config": "linux-devel-x86_64",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "13288066111"
    },
    {
      "job": 126330654727,
      "time": 107,
      "config": "linux-release-x86_64",
      "r": "4.6.2",
      "check": "OK",
      "artifact": "13287548177"
    },
    {
      "job": 126330654811,
      "time": 107,
      "config": "macos-oldrel-arm64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "13287453402"
    },
    {
      "job": 126330654836,
      "time": 105,
      "config": "macos-release-arm64",
      "r": "4.6.2",
      "check": "OK",
      "artifact": "13287792208"
    },
    {
      "job": 126329467761,
      "time": 196,
      "config": "source",
      "r": "4.6.2",
      "check": "OK",
      "artifact": "13287747441"
    },
    {
      "job": 126330654877,
      "time": 97,
      "config": "wasm-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "13288890605"
    },
    {
      "job": 126330654815,
      "time": 70,
      "config": "windows-devel-x86_64",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "13287757300"
    },
    {
      "job": 126330654762,
      "time": 57,
      "config": "windows-oldrel-x86_64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "13288705483"
    },
    {
      "job": 126330654957,
      "time": 79,
      "config": "windows-release-x86_64",
      "r": "4.6.2",
      "check": "OK",
      "artifact": "13288031878"
    }
  ],
  "_buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582",
  "_commit": {
    "id": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
    "author": "fvafrcu <fvafrcu@mailbox.org>",
    "committer": "fvafrcu <fvafrcu@mailbox.org>",
    "message": "adjust TODO.md\n",
    "time": 1748169406
  },
  "_distro": "resolute",
  "_host": "GitHub-Actions",
  "_registered": true,
  "_dependencies": [
    {
      "package": "R",
      "version": ">= 3.3.0",
      "role": "Depends"
    },
    {
      "package": "callr",
      "role": "Imports"
    },
    {
      "package": "checkmate",
      "role": "Imports"
    },
    {
      "package": "desc",
      "role": "Imports"
    },
    {
      "package": "fritools",
      "role": "Imports"
    },
    {
      "package": "rcmdcheck",
      "role": "Imports"
    },
    {
      "package": "roxygen2",
      "role": "Imports"
    },
    {
      "package": "rstudioapi",
      "role": "Imports"
    },
    {
      "package": "knitr",
      "role": "Suggests"
    },
    {
      "package": "pkgload",
      "role": "Suggests"
    },
    {
      "package": "rmarkdown",
      "role": "Suggests"
    },
    {
      "package": "RUnit",
      "role": "Suggests"
    },
    {
      "package": "testthat",
      "role": "Suggests"
    }
  ],
  "_owner": "gitlab-fvafrcu",
  "_selfowned": true,
  "_usedby": 0,
  "_updates": [],
  "_tags": [],
  "_userbio": {
    "uuid": 10984039,
    "type": "user",
    "name": "fvafrcu",
    "followers": 2
  },
  "_downloads": {
    "count": 550,
    "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/document"
  },
  "_mentions": 1,
  "_devurl": "https://gitlab.com/fvafrcu/document",
  "_searchresults": 440,
  "_rbuild": "4.6.2",
  "_assets": [
    "extra/citation.cff",
    "extra/citation.html",
    "extra/citation.json",
    "extra/citation.txt",
    "extra/contents.json",
    "extra/document.html",
    "extra/manual.pdf",
    "extra/NEWS.html",
    "extra/NEWS.txt",
    "extra/readme.html",
    "extra/readme.md",
    "LICENSE"
  ],
  "_homeurl": "https://gitlab.com/fvafrcu/document",
  "_realowner": "fvafrcu",
  "_cranurl": true,
  "_releases": [
    {
      "version": "1.0.0",
      "date": "2017-05-08"
    },
    {
      "version": "1.1.0",
      "date": "2017-05-19"
    },
    {
      "version": "1.2.0",
      "date": "2017-06-01"
    },
    {
      "version": "1.2.1",
      "date": "2017-07-07"
    },
    {
      "version": "2.0.0",
      "date": "2017-08-04"
    },
    {
      "version": "2.1.0",
      "date": "2017-08-18"
    },
    {
      "version": "2.2.0",
      "date": "2017-12-09"
    },
    {
      "version": "2.2.1",
      "date": "2018-01-13"
    },
    {
      "version": "3.0.0",
      "date": "2018-02-11"
    },
    {
      "version": "3.0.1",
      "date": "2018-03-20"
    },
    {
      "version": "3.0.2",
      "date": "2018-09-13"
    },
    {
      "version": "3.1.0",
      "date": "2018-11-25"
    },
    {
      "version": "3.2.0",
      "date": "2020-01-11"
    },
    {
      "version": "3.3.0",
      "date": "2020-10-30"
    },
    {
      "version": "3.3.1",
      "date": "2021-03-31"
    },
    {
      "version": "3.3.2",
      "date": "2021-05-12"
    },
    {
      "version": "3.3.3",
      "date": "2022-03-30"
    },
    {
      "version": "3.3.4",
      "date": "2022-08-19"
    },
    {
      "version": "4.0.0",
      "date": "2023-06-14"
    },
    {
      "version": "4.0.1",
      "date": "2025-05-27"
    }
  ],
  "_exports": [
    "document",
    "get_dpd",
    "man",
    "usage"
  ],
  "_help": [
    {
      "page": "document-package",
      "title": "Document a Single R Code File",
      "topics": [
        "document-package"
      ]
    },
    {
      "page": "document",
      "title": "Document (Chunks of) an R Code File",
      "topics": [
        "document"
      ]
    },
    {
      "page": "man",
      "title": "Display a Help Page From a File's Documentation",
      "topics": [
        "man"
      ]
    },
    {
      "page": "usage",
      "title": "Return the Usage of a Function From Within the Function",
      "topics": [
        "usage"
      ]
    }
  ],
  "_readme": "https://gitlab.com/fvafrcu/document/raw/HEAD/README.md",
  "_rundeps": [
    "backports",
    "brew",
    "callr",
    "checkmate",
    "cli",
    "commonmark",
    "cpp11",
    "curl",
    "desc",
    "digest",
    "evaluate",
    "fritools",
    "fs",
    "glue",
    "highr",
    "knitr",
    "lifecycle",
    "otel",
    "pkgbuild",
    "pkgload",
    "prettyunits",
    "processx",
    "ps",
    "R6",
    "rcmdcheck",
    "rdtools",
    "rlang",
    "roxygen2",
    "rprojroot",
    "rstudioapi",
    "sessioninfo",
    "withr",
    "xfun",
    "xml2",
    "xopen",
    "yaml"
  ],
  "_vignettes": [
    {
      "source": "Introduction_to_document.Rmd",
      "filename": "Introduction_to_document.html",
      "title": "An Introduction to document",
      "author": "Andreas Dominik Cullmann",
      "engine": "knitr::rmarkdown",
      "headings": [
        "Teaser",
        "Features",
        "Writing Documentation Files to Disk",
        "A Minimal Example",
        "Checking the code with R CMD check",
        "A Simple Example",
        "Displaying Temporary Help Files"
      ],
      "created": "2017-04-23 13:19:12",
      "modified": "2022-08-17 08:36:48",
      "commits": 29
    }
  ],
  "_score": 5.342422680822207,
  "_indexed": true,
  "_nocasepkg": "document",
  "_universes": [
    "fvafrcu",
    "gitlab-fvafrcu"
  ],
  "_binaries": [
    {
      "r": "4.7.0",
      "os": "linux",
      "version": "4.0.1.9000",
      "date": "2026-11-04T01:41:08.000Z",
      "distro": "resolute",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/79a4a958c407362ce5f1802fbdad2bb91d5a122ae6a774a849c8cea1d58a49af",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582"
    },
    {
      "r": "4.6.2",
      "os": "linux",
      "version": "4.0.1.9000",
      "date": "2026-11-04T01:41:00.000Z",
      "distro": "resolute",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/e1daf2688a3afccec0053fa838b1311bb63e1139b5f2b274a6bbb2bd0ebdfb32",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582"
    },
    {
      "r": "4.5.3",
      "os": "mac",
      "version": "4.0.1.9000",
      "date": "2026-11-04T01:40:58.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/8e832babcad66bbc36daf8ac1991c9b62e79b1c5e7acdad0cd433d87874790cf",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582"
    },
    {
      "r": "4.6.2",
      "os": "mac",
      "version": "4.0.1.9000",
      "date": "2026-11-04T01:40:56.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/2f99d260ba581b3f9724d8e7dbfdb44b392d5c3b39678cff0425388007935d87",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582"
    },
    {
      "r": "4.6.0",
      "os": "wasm",
      "version": "4.0.1.9000",
      "date": "2026-11-04T01:41:02.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/d6c4172543e316563f17899d41682992e66c6be8317d3a5e97d9ee18374fd259",
      "status": "success",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582"
    },
    {
      "r": "4.7.0",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-11-04T01:40:14.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/2e7839a0f19bb95e145890d53ddd12e014670c21ff8f63ec4c6d7c5691cfad58",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582"
    },
    {
      "r": "4.5.3",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-11-04T01:40:08.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/7624e981a059a2449c193d5a585e0b0cbc136020e74c2b102b9da6b949cb4c99",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582"
    },
    {
      "r": "4.6.2",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-11-04T01:40:25.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/6ffa83d50ef224f394870907d0b5cef8b3deedfcb68e6338b6f4eeb1b71e9205",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/41755129582"
    }
  ]
}