Skip to content

Commit

Permalink
ENH: Add CITATION schema file and recommend preference over dataset_d…
Browse files Browse the repository at this point in the history
…escription
  • Loading branch information
effigies committed Jun 25, 2023
1 parent c69d563 commit 1dd848a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/modality-agnostic-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,21 @@ A guide for using macros can be found at
-->
{{ MACROS___render_text("objects.files.README.description") }}

### `CITATION.cff`

<!-- This block generates a file tree.
A guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___render_text("objects.files.CITATION.description") }}

For most redundant fields between `CITATION.cff` and `dataset_description.json`,
the `CITATION.cff` SHOULD take precedence.
To avoid inconsistency, metadata present in `CITATION.cff` SHOULD NOT be
be included in `dataset_description.json`, with the exception of `Name` and
`DatasetDOI`, to ensure that `CITATION.cff`-unaware tools can generate
references to the dataset.

### `CHANGES`

<!-- This block generates a description.
Expand Down
8 changes: 8 additions & 0 deletions src/schema/objects/files.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ CHANGES:
[CPAN Changelog convention](https://metacpan.org/pod/release/HAARG/CPAN-Changes-0.400002/lib/\
CPAN/Changes/Spec.pod).
The `CHANGES` file MUST be either in ASCII or UTF-8 encoding.
CITATION:
display_name: CITATION.cff
file_type: regular
description: |
A description of the citation information for the dataset, following the
[Citation File Format](https://citation-file-format.github.io/) specification.
This file permits more detailed and structured descriptions than
[dataset_description.json](SPEC_ROOT/glossary.md#dataset_description-files).
LICENSE:
display_name: License
file_type: regular
Expand Down

0 comments on commit 1dd848a

Please sign in to comment.