LoginSign Up
← Back to all sparks
R

roxygen2

INFRA · APIS
Velocity2.5

Generate R package documentation and namespace files from inline source comments

github.com/r-lib/roxygen2 ↗

roxygen2 8.0 cut stringi out of the entire devtools dependency tree.

rdocumentationdevtoolsdependenciesmarkdown
◆Current state
roxygen2 turns inline comments into R documentation and NAMESPACE files. The 8.0.0 release was as much about dependencies as features: dropping purrr, stringr and stringi means nothing in the devtools constellation pulls in stringi, long a persistent install obstacle on constrained Linux systems. 8.1.0 follows with markdown correctness work and cached link resolution.
◆Where it's heading
The package is investing in the documentation toolchain beneath it — a new rdtools package supplies cached indexes so link targets and inherited Rd topics resolve without repeated help() lookups. Running alongside is steady correction of markdown handling, where multibyte characters inside Rd tags had been corrupting everything that followed.
◆Prediction
Expect more Rd processing to migrate into rdtools, and further link-resolution changes now that all generated links share a single code path.

◆Recent moves

  1. 8d ago

    roxygen2 8.1.0 resolves links via cached rdtools indexes

    Link targets and inherited Rd topics now resolve through cached indexes from the new rdtools package instead of repeated help() calls — an architectural shift in how roxygen2 finds documentation. The multibyte fix is the more visible one: a tag like \code{café} had been corrupting markdown processing of all following text.

    View source ↗
  2. 3mo ago

    roxygen2 8.0.0 drops stringi from the devtools dependency chain

    ⚡ SPARK

    A major version defined by what it removes: purrr, stringr and stringi all go, taking stringi out of the devtools dependency chain entirely. Link generation is also unified into one code path, which will shift some output on re-documentation.

    View source ↗
  3. 11mo ago

    roxygen2 7.3.3 auto-resolves markdown links to external topics

    Unqualified markdown links to topics in external packages now resolve automatically, custom @family titles accept markdown, and ROR IDs become useful links. The unexported S3 method check also stops hanging when a package carries a largish data object.

    View source ↗
  4. 2y ago

    roxygen2 7.3.2 disables cli hyperlinks in included Rmd

    @includeRmd sets cli.hyperlink to FALSE so included .Rmd code behaves consistently across sessions. A single determinism fix.

    View source ↗
  5. 2y ago

    roxygen2 7.3.1 fixes @importFrom for quoted non-syntactic names

    A cluster of parsing edge cases: S3 export warnings survive class names containing braces, @family lists order more carefully, and @importFrom works again for quoted non-syntactic names. Correctness detail rather than new capability.

    View source ↗
  6. 2y ago

    roxygen2 7.3.0 reports S3 methods missing @export

    The NAMESPACE roclet starts reporting S3 methods missing an @export tag, catching a genuine and easily missed packaging error. @docType package is nudged toward the "_PACKAGE" convention it is meant to be replaced by.

    View source ↗