Skip to content

Add CITATION.cff#347

Merged
LiNk-NY merged 1 commit into
develfrom
ci/update-citation-cff-24527883700
Apr 16, 2026
Merged

Add CITATION.cff#347
LiNk-NY merged 1 commit into
develfrom
ci/update-citation-cff-24527883700

Conversation

@LiNk-NY
Copy link
Copy Markdown
Collaborator

@LiNk-NY LiNk-NY commented Apr 16, 2026

This automated PR adds or updates CITATION.cff using the
cffr R package (cffr::cff_write()).
Citation metadata is derived from the package DESCRIPTION, and the
auto-citation is also included as a references entry.

Changes

  • Added / updated CITATION.cff – generated by cffr::cff_write() with
    the auto-citation included under references

How citations are handled

  • If inst/CITATION exists in the repository it is automatically used by
    cff_write() as the preferred-citation in CITATION.cff.
  • Otherwise, citation metadata is derived solely from DESCRIPTION.
  • The auto-citation (equivalent to citation(".", auto = TRUE)) is always
    included under the references key so that both the preferred and the
    software citation are present.

Why

A CITATION.cff file makes it easy for users and tools (GitHub, Zenodo,
Zotero, etc.) to cite your package correctly.

Customisation

You can further customise the generated file by editing CITATION.cff
directly after this PR is merged. See the
cffr vignette for
details.

Opened by the repo-audits workflow (run #24527883700).

@LiNk-NY LiNk-NY merged commit ef3ea22 into devel Apr 16, 2026
4 checks passed
@LiNk-NY LiNk-NY deleted the ci/update-citation-cff-24527883700 branch April 29, 2026 19:55
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.

1 participant