{
  "_id": "6aacfd5a3d719c1f840743a6",
  "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-09-18 08:31:41 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/440fe73598864220e3d76f5e62857a17ff8be8af11c18342f1a68d9f9d3084da",
  "_filesize": 139498,
  "_sha256": "440fe73598864220e3d76f5e62857a17ff8be8af11c18342f1a68d9f9d3084da",
  "_expires": "2026-12-27T08:59:04.000Z",
  "_created": "2026-09-18T08:31:41.000Z",
  "_published": "2026-09-18T08:59:06.718Z",
  "_jobs": [
    {
      "job": 105535408200,
      "time": 157,
      "config": "linux-devel-x86_64",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "10538467047"
    },
    {
      "job": 105535408225,
      "time": 129,
      "config": "linux-release-x86_64",
      "r": "4.6.1",
      "check": "OK",
      "artifact": "10538202279"
    },
    {
      "job": 105535408197,
      "time": 84,
      "config": "macos-oldrel-arm64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "10539451529"
    },
    {
      "job": 105535408142,
      "time": 94,
      "config": "macos-release-arm64",
      "r": "4.6.1",
      "check": "OK",
      "artifact": "10538639110"
    },
    {
      "job": 105534556047,
      "time": 186,
      "config": "source",
      "r": "4.6.1",
      "check": "OK",
      "artifact": "10538331876"
    },
    {
      "job": 105535408121,
      "time": 126,
      "config": "wasm-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "10539126886"
    },
    {
      "job": 105535408152,
      "time": 82,
      "config": "windows-devel-x86_64",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "10538466913"
    },
    {
      "job": 105535408136,
      "time": 71,
      "config": "windows-oldrel-x86_64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "10538521889"
    },
    {
      "job": 105535408112,
      "time": 68,
      "config": "windows-release-x86_64",
      "r": "4.6.1",
      "check": "OK",
      "artifact": "10538887253"
    }
  ],
  "_host": "GitHub-Actions",
  "_buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399",
  "_status": "success",
  "_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
  },
  "_distro": "resolute",
  "_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": 473,
    "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/document"
  },
  "_mentions": 1,
  "_devurl": "https://gitlab.com/fvafrcu/document",
  "_searchresults": 313,
  "_rbuild": "4.6.1",
  "_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.194514341882467,
  "_indexed": true,
  "_nocasepkg": "document",
  "_universes": [
    "fvafrcu",
    "gitlab-fvafrcu"
  ],
  "_binaries": [
    {
      "r": "4.7.0",
      "os": "linux",
      "version": "4.0.1.9000",
      "date": "2026-09-18T08:34:15.000Z",
      "distro": "resolute",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/9747dfbc5e661707f62179dab8b83710db86a7fa23f2e5a6131f39923524dc7f",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399"
    },
    {
      "r": "4.6.1",
      "os": "linux",
      "version": "4.0.1.9000",
      "date": "2026-09-18T08:33:50.000Z",
      "distro": "resolute",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/a0d39f49257e5ae1b436f4af131489ff2e4b38dc77e6ac4ff91f22d34cacc689",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399"
    },
    {
      "r": "4.5.3",
      "os": "mac",
      "version": "4.0.1.9000",
      "date": "2026-09-18T08:58:28.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/953f017ab23fd7158cba9ec34c0c0154e17cf48e95f882caddc16a22a0797d65",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399"
    },
    {
      "r": "4.6.1",
      "os": "mac",
      "version": "4.0.1.9000",
      "date": "2026-09-18T08:54:41.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/9656e2a8efe3108d48df95b656b8bed1aa0064e5c6de6dea1ecff688c9e7da83",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399"
    },
    {
      "r": "4.6.0",
      "os": "wasm",
      "version": "4.0.1.9000",
      "date": "2026-09-18T08:34:00.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/26301c9561a87216cb13310e4dfb0374c5521dda1a61e4d59777aa217ec96258",
      "status": "success",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399"
    },
    {
      "r": "4.7.0",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-09-18T08:32:59.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/f7fad705f022e5ef227fec8e82c401a463e7e0af308c94f1535df4d7b7602ee4",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399"
    },
    {
      "r": "4.5.3",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-09-18T08:32:47.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/3dea60e885d7a82fe3c6e997ba203653525a4aa5eb24bdacf85ca57e04a31198",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399"
    },
    {
      "r": "4.6.1",
      "os": "win",
      "version": "4.0.1.9000",
      "date": "2026-09-18T08:32:46.000Z",
      "commit": "881e2a0a05e2cd0dcf7c8b550ce99833233c4baa",
      "fileid": "https://r2.ropensci.org/4a1b169a40374bc2d70f8cb46cd6cf5161a00f868cf86643869031e4566102ea",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/fvafrcu/actions/runs/35324550399"
    }
  ]
}