Skip to content

roxygen2 should not assume ORCIDs are "bare" #1040

@cboettig

Description

@cboettig

Roxygen is incorrectly assuming that ORCIDs in the DESCRIPTION are always entered without the https://, see

desc <- paste0(desc, " (\\href{https://orcid.org/", x$comment[["ORCID"]], "}{ORCID})")

ORCID guidelines say that the ID should always display the URI format, https://orcid.org/content/journal-article-display-guidelines, and so I always include the https://orcid.org/ part in my DESCRIPTION (a URI is much more robust / useful than a bare identifier). I think roxygen should at least check for http[s] first before it goes and appends it.

Note that it looks like CRAN does not make this assumption, and registers the ORCID link correctly on the CRAN webpage when the developer already has the full URI. (However I think pkgdown sites use the URIs generated here, and so are also creating invalid links in this case).

Thanks much!! Really appreciate the support for ORCID across the R community!

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugan unexpected problem or unintended behavior

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions