Skip to content

[codex] Add CITATION.cff - #39

Merged
gvegayon merged 1 commit into
masterfrom
codex/add-citation-cff
Sep 11, 2026
Merged

gvegayon merged 1 commit into
masterfrom
codex/add-citation-cff

Conversation

@gvegayon

Copy link
Copy Markdown
Member

GitHub cannot presently discover structured citation metadata for this R package. This pull request adds a root CITATION.cff, preserves the repository's existing citation preference, excludes the repository-only file from the R source tarball, and adds a read-only schema-validation workflow.

The existing inst/CITATION remains authoritative for citation(); the new CFF enables GitHub and other CFF consumers without changing package behavior.

Validated with cffconvert --validate, cffr::cff_validate(), and R CMD build --no-build-vignettes; the source tarball excludes CITATION.cff.

Note: This pull request was prepared by GPT-5.6 Terra on behalf of gvegayon.

@github-actions

Copy link
Copy Markdown

Thank you for your contribution @gvegayon 🚀! The pkgdown site preview is ready for review 👉 Download here 👈!
(The artifact expires on 2026-12-10T05:22:57Z. You can re-generate it by re-running the workflow here.)

@gvegayon
gvegayon marked this pull request as ready for review September 11, 2026 05:44
Copilot AI lite review requested due to automatic review settings September 11, 2026 05:44
@gvegayon
gvegayon merged commit 7519376 into master Sep 11, 2026
14 of 15 checks passed
@gvegayon
gvegayon deleted the codex/add-citation-cff branch September 11, 2026 05:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

CITATION.cff has incomplete authorship and an incorrect reference link.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds machine-readable citation metadata for GitHub and CFF consumers while preserving existing R citation behavior.

Changes:

  • Adds root CITATION.cff.
  • Excludes it from R source tarballs.
  • Adds a pinned, read-only validation workflow.
File summaries
File Summary Review findings
CITATION.cff Defines structured citation metadata. Moderate: add Paul Marjoram to the authors list and correct the Haario (2001) DOI/source URL.
.Rbuildignore Excludes repository-only metadata from builds. None.
.github/workflows/validate-citation-cff.yml Validates CFF metadata automatically. None.
Review details

Suppressed comments (1)

CITATION.cff:21

  • The top-level authors list omits Paul Marjoram even though the package metadata identifies him as a contributor and both the preferred and manual citations include him. CFF consumers that use the software-level author list will therefore report incomplete authorship; add him here as well.
authors:
- family-names: Vega Yon
  given-names: George
  email: g.vegayon@gmail.com
  orcid: https://orcid.org/0000-0002-3171-0844
  • Files reviewed: 3/3 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread CITATION.cff
specify automatic convergence checker, personalized transition kernels, and out-of-the-box
multiple MCMC chains using parallel computing. Most of the methods implemented in
this package can be found in Brooks et al. (2011, ISBN 9781420079425). Among the
methods included, we have: Haario (2001) <https://doi.org/10.1007/s11222-011-9269-5>
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.

2 participants