Add CITATION.cff#347
Merged
Merged
Conversation
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.
This automated PR adds or updates
CITATION.cffusing thecffr R package (
cffr::cff_write()).Citation metadata is derived from the package
DESCRIPTION, and theauto-citation is also included as a
referencesentry.Changes
CITATION.cff– generated bycffr::cff_write()withthe auto-citation included under
referencesHow citations are handled
inst/CITATIONexists in the repository it is automatically used bycff_write()as thepreferred-citationinCITATION.cff.DESCRIPTION.citation(".", auto = TRUE)) is alwaysincluded under the
referenceskey so that both the preferred and thesoftware citation are present.
Why
A
CITATION.cfffile 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.cffdirectly after this PR is merged. See the
cffr vignette for
details.
Opened by the repo-audits workflow (run #24527883700).