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.

Sign up for GitHub

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

Jump to bottom

[ENH] Add a statement addressing metadata conflicts #761

Closed
wants to merge 1 commit into from
Closed

[ENH] Add a statement addressing metadata conflicts #761

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/common-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,25 @@ and/or files (like `events.tsv`) are fully omitted *when they are unavailable or
instead of specified with an `n/a` value, or included as an empty file
(for example an empty `events.tsv` file with only the headers included).

### Metadata conflicts

BIDS specifies that metadata be stored in human-readable formats such as
TSV (see [Tabular files](#tabular-files)) or
JSON (see [Key/value files](#keyvalue-files-dictionaries)).
In some cases, this duplicates metadata contained in a data file.

In cases of conflict, the BIDS metadata is considered authoritative.
If BIDS metadata is defined,
format-specific metadata MUST NOT conflict to the extent permitted by the format.

If an exact representation of the BIDS metadata is possible in the format,
then the metadata SHOULD be duplicated inside the data file.
If an exact representation of the BIDS metadata is not possible in the format,
then the closest possible approximation of the BIDS metadata SHOULD be used.
Special null or undefined values MAY be used when available.
If the format-specific metadata field is defined,
the BIDS metadata SHOULD also be defined.

## Filesystem structure

Data for each subject are placed in subdirectories named "`sub-<label>`",
Expand Down