Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include CITATION.cff v1.3.0 as a way to cite authors and their contributions #2881

Open
ericearl opened this issue Sep 1, 2023 · 0 comments

Comments

@ericearl
Copy link

ericearl commented Sep 1, 2023

What would you like to see added?

We at the NIMH Data Science & Sharing Team (@agt24, @dmoracze, @Arshitha, @ericearl) would like to see OpenNeuro support CITATION.cff v1.3.0 files as a way to cite authors and their contributions instead of only the "Authors" field of the dataset_description.json.

There has been some work in the citation-file-format/citation-file-format repo enabling "contributions" as a field (v1.3.0-alpha.0):
citation-file-format/citation-file-format#338

And some work in the bids-standard/bids-specification repo to include CITATION.cff as a supported format (PR#1525):
bids-standard/bids-specification#1525

I have uploaded an example dataset with a CITATION.cff file here:
https://openneuro.org/datasets/ds004654

That CITATION.cff follows the rules here with one exception: "ReferencesAndLinks" from the dataset_description.json are not omitted and replaced by "references" in the CITATION.cff file because I ran out of time before my upcoming leave to update all that in the CITATION.cff.

Alternatives

One consideration I think is that people may sometimes accidentally provide both the dataset_description.json fields and the CITATION.cff fields where the CITATION.cff file takes precedence (Authors, HowToAcknowledge, License, and ReferencesAndLinks). I feel as long as there is a clear bids-validator message that these fields are taking precedence over the dataset_description.json's fields, it is fine to have both, but advisable to have each bit of data in only one of the two files to prevent inconsistency.

Do you have any interest in helping implement the feature?

Yes, but I would need guidance

Additional information / screenshots

If you need me to do anything else to this input/example data, let us all know and one of us will get to it.

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

No branches or pull requests

1 participant