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

ORCID #63

Closed
maelle opened this issue Apr 25, 2018 · 5 comments
Closed

ORCID #63

maelle opened this issue Apr 25, 2018 · 5 comments

Comments

@maelle
Copy link
Contributor

maelle commented Apr 25, 2018

One can now add ORCID for authors of a package on CRAN and it's shown with a nice icon in the CRAN page of a package e.g. https://cran.r-project.org/web/packages/fasterize/index.html

I'm wondering how to use desc to add an ORCID for an author. Should this be a separate argument of authors helpers, although the ORCID information is supposed to live in comment (as per https://cran.r-project.org/web/packages/submission_checklist.html "For persons with an ORCID identifier (see https://orcid.org/ for more information, provide the identifier via an element named "ORCID" in the comment argument of person(). Example: person("Achim", "Zeileis", comment = c(ORCID = "0000-0003-0918-3766")). ")?

Currently when trying to add the ORCID via comment I used this workflow

descr <- desc::desc(find.package("desc"))
descr$add_author(given = "Nice",
                 family = "Developer",
                 comment = c(ORCID = "orcid_number"))
descr$write("DESCRIPTION")

Maybe this is not the right way to save DESCRIPTION? If it is, when using this in the file comment becomes "comment = structure("orcid_number", .Names = "ORCID"))" which I'm not sure would be parsed by CRAN (but I haven't tried).

@gaborcsardi
Copy link
Member

Should this be a separate argument of authors helpers

yes

Maybe this is not the right way to save DESCRIPTION?

No, it is OK. You can also just do

desc_add_author(given = "Nice",
                 family = "Developer",
                 comment = c(ORCID = "orcid_number"))

to do it in one go.

which I'm not sure would be parsed by CRAN (but I haven't tried).

It is fine for CRAN, but I agree that it does not look nice. Do you want to submit a PR to add an orcid argument?

@maelle
Copy link
Contributor Author

maelle commented May 1, 2018

Thanks!

Yes I will prepare a PR ☺

@maelle
Copy link
Contributor Author

maelle commented Sep 4, 2018

I wonder whether I should also add an add_orcid function/method, because I know I'd use it to complement existing DESCRIPTION files.

@llrs
Copy link
Contributor

llrs commented Sep 4, 2018

I think it would be useful to have add_orcid, it will help a lot with existing packages (maybe it will get used in usethis)

@maelle maelle mentioned this issue Sep 25, 2018
@maelle
Copy link
Contributor Author

maelle commented Sep 27, 2018

Fixed in #70 💃

@maelle maelle closed this as completed Sep 27, 2018
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