Skip to content

docs: add an R CITATION file, ORCID and the CRAN DOI - #54

Merged
novica merged 2 commits into
mainfrom
citation-orcid
Oct 11, 2026
Merged

novica merged 2 commits into
mainfrom
citation-orcid

Conversation

@novica

@novica novica commented Oct 11, 2026 •

Copy link
Copy Markdown
Owner

Summary

Makes the package citable with the right authors, ORCID and DOI.

  • R citation file (Add R citation file #51): new inst/CITATION. Without it, citation("ParBayesianOptimization") listed only Samuel Wilson, with no year and a warning. The version is read from DESCRIPTION, and the year from CRAN's Date/Publication (current year for GitHub installs).
  • ORCID (Add ORCID to citation.cff and DESCRIPTION #52): added for Novica Nakov in DESCRIPTION and CITATION.cff. Novica Nakov's role in DESCRIPTION is now c("aut", "cre"), matching the citation files. Samuel Wilson, the original author, is now listed first in DESCRIPTION, matching the order in the citation files; the maintainer is still taken from the cre role.
  • DOI (Add DOI to README and to CITATION #53): the CRAN DOI 10.32614/CRAN.package.ParBayesianOptimization is in inst/CITATION, CITATION.cff and a README badge. It already resolves, so no per-release DOI is needed.
  • Also fixes the README downloads badge, which showed the download count for mltools instead of this package.

Typed docs: so it ships in 1.4.1.

citation("ParBayesianOptimization") now gives:

Wilson S, Nakov N (2026). _ParBayesianOptimization: Parallel Bayesian
Optimization of Hyperparameters_.
doi:10.32614/CRAN.package.ParBayesianOptimization
<https://doi.org/10.32614/CRAN.package.ParBayesianOptimization>. R
package version 1.4.0,
<https://CRAN.R-project.org/package=ParBayesianOptimization>.

Related GitHub Issues and PRs

Are these changes tested?

R CMD check --as-cran passes 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 in DESCRIPTION, 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:

  • Human
  • AI

Reviewed before submission by:

  • Human
  • AI
  • Not reviewed

Checklist

  • I understand and agree to the Code of Conduct.
  • The PR title follows Conventional Commits (fix:, feat:, docs:, ...); it becomes the NEWS.md entry.
  • I have run air format . and jarl check ..
  • I have updated roxygen comments and run devtools::document() if documentation changed.
  • I have added testthat unit tests to tests/testthat for any new functionality or fixed bug.

Assisted-by: Claude Code

Without inst/CITATION, citation() listed only the original author and
no year, since the maintainer had no aut role.

Closes #51, closes #52, closes #53.

Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
Matches the order in inst/CITATION and CITATION.cff.

Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
@novica
novica merged commit 86c0d4e into main Oct 11, 2026
7 checks passed
@novica
novica deleted the citation-orcid branch October 11, 2026 17:22
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

Successfully merging this pull request may close these issues.

Add DOI to README and to CITATION Add ORCID to citation.cff and DESCRIPTION Add R citation file

1 participant