bids-specification/src/schema/rules/json/dataset.yaml at 187d8727193af37b0c10299f18cdf6b1e348e973 · bids-standard/bids-specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
---
dataset_description:
  selectors:
    - path == "/dataset_description.json"
  fields:
    Name: required
    BIDSVersion: required
    HEDVersion: recommended
    DatasetLinks:
      level: optional
      level_addendum: required if [BIDS URIs](SPEC_ROOT/common-principles.md#bids-uri) are used
    DatasetType: recommended
    License: recommended
    Authors:
      level: optional
      level_addendum: recommended if `CITATION.cff` is not present
    Keywords: optional
    Acknowledgements: optional
    HowToAcknowledge: optional
    Funding: optional
    EthicsApprovals: optional
    ReferencesAndLinks: optional
    DatasetDOI: optional
    GeneratedBy: recommended
    SourceDatasets: recommended

dataset_authors:
  selectors:
    - path == "/dataset_description.json"
    - '!exists("CITATION.cff", "dataset")'
  fields:
    Authors:
      level: recommended
      issue:
        code: NO_AUTHORS
        message: |
          The Authors field of dataset_description.json should contain an array of fields -
          with one author per field. This was triggered because there are no authors, which
          will make DOI registration from dataset metadata impossible.

derivative_description:
  selectors:
    - path == "/dataset_description.json"
    - json.DatasetType == "derivative"
  fields:
    GeneratedBy: required