{
  "_id": "6a1eef68b401979e73412b92",
  "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-05-19 08:39:46 UTC",
    "User": "root"
  },
  "Author": "Andreas Dominik Cullmann [aut, cre]",
  "Maintainer": "Andreas Dominik Cullmann <fvafrcu@mailbox.org>",
  "MD5sum": "6a9c1ae7d73b87a3f6b63869b3d2e02a",
  "_user": "fvafrcu",
  "_type": "src",
  "_file": "document_4.0.1.9000.tar.gz",
  "_fileid": "b59fd480971330fd9577ed6a3a10e0dbd21487e89a8afd41a2a2e975b4098ddc",
  "_filesize": 138647,
  "_sha256": "b59fd480971330fd9577ed6a3a10e0dbd21487e89a8afd41a2a2e975b4098ddc",
  "_created": "2026-05-19T08:39:46.000Z",
  "_published": "2026-06-02T14:57:44.396Z",
  "_distro": "noble",
  "_jobs": [
    {
      "job": 79101124942,
      "time": 130,
      "config": "linux-devel-x86_64",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "7078777845"
    },
    {
      "job": 79101125344,
      "time": 124,
      "config": "linux-release-x86_64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7078776150"
    },
    {
      "job": 79101126222,
      "time": 121,
      "config": "macos-oldrel-arm64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "7078774803"
    },
    {
      "job": 79101124950,
      "time": 139,
      "config": "macos-release-arm64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7078789828"
    },
    {
      "job": 79101124992,
      "time": 162,
      "config": "source",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7078731779"
    },
    {
      "job": 79101124306,
      "time": 152,
      "config": "wasm-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7361407004"
    },
    {
      "job": 79101125190,
      "time": 73,
      "config": "windows-devel",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "7078758118"
    },
    {
      "job": 79101126561,
      "time": 74,
      "config": "windows-oldrel",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "7078758522"
    },
    {
      "job": 79101125267,
      "time": 79,
      "config": "windows-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7078760430"
    }
  ],
  "_buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006",
  "_status": "success",
  "_host": "GitHub-Actions",
  "_upstream": "https://gitlab.com/fvafrcu/document",
  "_commit": {
    "id": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
    "author": "fvafrcu <fvafrcu@mailbox.org>",
    "committer": "fvafrcu <fvafrcu@mailbox.org>",
    "message": "adjust TODO.md\n",
    "time": 1748169406
  },
  "_maintainer": {
    "name": "Andreas Dominik Cullmann",
    "email": "fvafrcu@mailbox.org",
    "login": "fvafrcu",
    "description": "",
    "uuid": 10984039
  },
  "_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": [
    {
      "week": "2025-21",
      "n": 4
    }
  ],
  "_tags": [
    {
      "name": "4.0.1",
      "date": "2025-05-24"
    }
  ],
  "_userbio": {
    "uuid": 10984039,
    "type": "user",
    "name": "fvafrcu"
  },
  "_downloads": {
    "count": 679,
    "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/document"
  },
  "_mentions": 1,
  "_devurl": "https://gitlab.com/fvafrcu/document",
  "_searchresults": 172,
  "_rbuild": "4.6.0",
  "_assets": [
    "extra/citation.cff",
    "extra/citation.html",
    "extra/citation.json",
    "extra/citation.txt",
    "extra/contents.json",
    "extra/document.html",
    "extra/NEWS.html",
    "extra/NEWS.txt",
    "extra/readme.html",
    "extra/readme.md",
    "manual.pdf"
  ],
  "_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",
    "pkgbuild",
    "pkgload",
    "prettyunits",
    "processx",
    "ps",
    "R6",
    "rcmdcheck",
    "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": 4.9344984512435675,
  "_indexed": true,
  "_nocasepkg": "document",
  "_universes": [
    "fvafrcu",
    "gitlab-fvafrcu"
  ],
  "_binaries": [
    {
      "r": "4.7.0",
      "os": "linux",
      "version": "4.0.1.9000",
      "date": "2026-05-19T08:41:56.000Z",
      "distro": "noble",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "3dff94daea63bf0f2562cb20524eed9c22774ecac127d70c9398a61480d7d272",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006"
    },
    {
      "r": "4.6.0",
      "os": "linux",
      "version": "4.0.1.9000",
      "date": "2026-05-19T08:41:51.000Z",
      "distro": "noble",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "81370f91b400e1d5f3ebf422b8b8acdc5e89338cda6865cf380b9277529a16e6",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006"
    },
    {
      "r": "4.5.3",
      "os": "mac",
      "version": "4.0.1.9000",
      "date": "2026-05-19T08:41:45.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "10d038cb33f3112b2ed6bedbe2ce3e3e45f315292cf2583714d6cbc38d53933c",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006"
    },
    {
      "r": "4.6.0",
      "os": "mac",
      "version": "4.0.1.9000",
      "date": "2026-05-19T08:42:24.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "a79fcf0ce3d07bcf9d85af96ab7f72ffd444a56e71b970174c581f71b2a76a79",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006"
    },
    {
      "r": "4.7.0",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-05-19T08:40:56.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "dbf1200a7eb4a8eea4f0be9f157b70ca8b9f14bdece6f9948f59fd63d12915fb",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006"
    },
    {
      "r": "4.5.3",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-05-19T08:40:58.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "28ea18515e1d4e704c8d7639c1d55a4bceab53e627c888eb61dc5926461198f6",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006"
    },
    {
      "r": "4.6.0",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-05-19T08:41:03.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "53c29b131938f20ce33e2cc74fcac4b383e6ae7065a9128b12107778c16d505a",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006"
    },
    {
      "r": "4.6.0",
      "os": "wasm",
      "version": "4.0.1.9000",
      "date": "2026-06-02T14:57:24.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "2d959b36e5915f19ce19d13ed24cbdf9bc50e6e948f4f8b5ecc8fc04100fd6ff",
      "status": "success",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/26086010006"
    }
  ]
}