Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

roxygen2 should not assume ORCIDs are "bare" #1040

Closed
cboettig opened this issue Feb 4, 2020 · 1 comment
Closed

roxygen2 should not assume ORCIDs are "bare" #1040

cboettig opened this issue Feb 4, 2020 · 1 comment
Labels
bug

Comments

@cboettig
Copy link

@cboettig cboettig commented Feb 4, 2020

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!

cboettig added a commit to ropensci/emld that referenced this issue Feb 4, 2020
@hadley
Copy link
Member

@hadley hadley commented Mar 4, 2020

Would you be interested in doing a PR to fix this?

@hadley hadley added the bug label Mar 4, 2020
@hadley hadley closed this as completed Jun 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug
Projects
None yet
Development

No branches or pull requests

2 participants