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

use_description_defaults() contains invalid ORCID placeholder that throws error in R-devel #2059

Closed
slager opened this issue Sep 16, 2024 · 4 comments

Comments

@slager
Copy link

slager commented Sep 16, 2024

use_description_defaults() contains an invalid ORCID placeholder here:

"Authors@R" = 'person("First", "Last", email = "first.last@example.com", role = c("aut", "cre"), comment = c(ORCID = "YOUR-ORCID-ID"))',

When a package containing this default ORCID placeholder is built, a recent change to R-devel now catches the invalid ORCID. This is happening in the unit tests for my R package which is now failing CRAN checks on R-devel:

https://cran.r-project.org/web/checks/check_results_DataPackageR.html

@llrs
Copy link
Contributor

llrs commented Sep 17, 2024

It wouldn't be good to add a valid ORCID of someone that could end up with hundreds of packages on CRAN attributed... It works as a reminder for maintainers to add their own ORCID or delete it.
I hope you can submit a new version with this and the other problems fixed. Good luck!

@slager
Copy link
Author

slager commented Sep 17, 2024

I agree that hardcoding someone's real ORCID into usethis would be a bad idea.

ORCID is optional in a DESCRIPTION, so I would propose usethis just remove the invalid placeholder from the default.

@jennybc
Copy link
Member

jennybc commented Sep 17, 2024

The general philosophy of many usethis functions is to help people get fiddly files or bits of files in the correct form. That is the spirit of the ORCID placeholder here. It is much easier for someone to delete the placeholder if they don't wish to populate than it is for everyone else to look up the syntax (or, more likely, not bother with placing an ORCID even though they have one). So it's a question of net benefit to package developers.

@slager
Copy link
Author

slager commented Sep 17, 2024

Ok, sounds good. I will work around this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants