Repository navigation
docs: add an R CITATION file, ORCID and the CRAN DOI - #54
Merged
Merged
Conversation
Matches the order in inst/CITATION and CITATION.cff. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Makes the package citable with the right authors, ORCID and DOI.
inst/CITATION. Without it,citation("ParBayesianOptimization")listed only Samuel Wilson, with no year and a warning. The version is read fromDESCRIPTION, and the year from CRAN'sDate/Publication(current year for GitHub installs).DESCRIPTIONandCITATION.cff. Novica Nakov's role inDESCRIPTIONis nowc("aut", "cre"), matching the citation files. Samuel Wilson, the original author, is now listed first inDESCRIPTION, matching the order in the citation files; the maintainer is still taken from thecrerole.10.32614/CRAN.package.ParBayesianOptimizationis ininst/CITATION,CITATION.cffand a README badge. It already resolves, so no per-release DOI is needed.Typed
docs:so it ships in 1.4.1.citation("ParBayesianOptimization")now gives:Related GitHub Issues and PRs
Are these changes tested?
R CMD check --as-cranpasses locally with 0 errors, 0 warnings and 0 notes. The citation output above is from the package installed from this branch.Are there any user-facing changes?
Yes:
citation()output, author roles inDESCRIPTION, and the README badges.Was AI used for this PR?
In accordance with the AI generation guidelines, please disclose whether and how AI was used in this PR.
PR code and description written by:
Reviewed before submission by:
Checklist
fix:,feat:,docs:, ...); it becomes theNEWS.mdentry.air format .andjarl check ..devtools::document()if documentation changed.testthatunit tests totests/testthatfor any new functionality or fixed bug.Assisted-by: Claude Code