Roxygen2: How to deal with DOIs that include ">"

Created on 3 Nov 2020  ·  1Comment  ·  Source: r-lib/roxygen2

From https://stat.ethz.ch/pipermail/r-package-devel/2020q4/006236.html

If one has a DOI like <doi:10.1175/1520-0469(1981)038<1179:TSLROA>2.0.CO;2> in the package DESCRIPTION one needs to URLencode it for R CMD check to pass. I.e. "doi:10.1175/1520-0469(1981)038%3C1179:TSLROA%3E2.0.CO;2"

The problem is that the URL encoded version of the URL then gets written in the package-level manual page. And when going from Rd to HTML, the DOI is truncated after the "%".

Could roxygen2 transform DOIs to URLs and unencode their text?

bug rd

Most helpful comment

Like what pkgdown does in some places actually https://github.com/r-lib/pkgdown/blob/810084e8a9abd091378a6b75fa9d7de9ce637aa1/R/html-build.R#L16 :thinking: (the linkifying, but not the unescaping of the DOI, which is ok I suppose).

What one gets as index page with pkgdown in the absence of an index source is nice with the clickable DOIs.

>All comments

Like what pkgdown does in some places actually https://github.com/r-lib/pkgdown/blob/810084e8a9abd091378a6b75fa9d7de9ce637aa1/R/html-build.R#L16 :thinking: (the linkifying, but not the unescaping of the DOI, which is ok I suppose).

What one gets as index page with pkgdown in the absence of an index source is nice with the clickable DOIs.

Was this page helpful?
0 / 5 - 0 ratings