Skip to content

Commit

Permalink
fix some remark warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
Remi-Gau authored and effigies committed Jan 21, 2025
1 parent 4218b87 commit 9c9591e
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 15 deletions.
9 changes: 6 additions & 3 deletions src/common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ REQUIRED, RECOMMENDED, and OPTIONAL.
The guiding principles for when particular data is placed under a given requirement level
can be loosely described as below:

* REQUIRED: Data cannot be be interpreted without this information (or the ambiguity is unacceptably high)
* RECOMMENDED: Interpretation/utility would be dramatically improved with this information
* OPTIONAL: Users and/or tools might find it useful to have this information
- REQUIRED: Data cannot be be interpreted without this information (or the ambiguity is unacceptably high)
- RECOMMENDED: Interpretation/utility would be dramatically improved with this information
- OPTIONAL: Users and/or tools might find it useful to have this information

Throughout this specification we use a list of terms and abbreviations.
To avoid misunderstanding we clarify them here.
Expand Down Expand Up @@ -484,6 +484,7 @@ with two exceptions:
1. [compressed tabular files](#compressed-tabular-files),
for which column names are defined in a sidecar metadata
[JSON object](https://www.json.org/json-en.html) described below; and
1. [motion recording data](modality-specific-files/motion.md),
which use plain-text TSV and columns are defined as described
in its corresponding section of the specifications.
Expand Down Expand Up @@ -606,8 +607,10 @@ Rules for formatting plain-text tabular files apply to TSVGZ files with three ex

1. The contents of TSVGZ files MUST be compressed with
[gzip](https://datatracker.ietf.org/doc/html/rfc1952).

1. Compressed tabular files MUST NOT contain a header in the first row
indicating the column names.

1. TSVGZ files MUST have an associated JSON file that defines the columns in the tabular file.

!!! warning "Attention"
Expand Down
10 changes: 5 additions & 5 deletions src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,11 @@ For example:

#### Motion

- Jeung, S., Cockx, H., Appelhoff, S., Berg, T., Gramann, K., Grothkopp, S., Warmerdam, E., Hansen, C.,
Oostenveld, R., BIDS maintainers, Welzel, J. (2023).
**Motion-BIDS: extending the Brain Imaging Data Structure specification to organize motion data for reproducible research**.
PsyArXiv.
[doi:10.31234/osf.io/w6z79](https://doi.org/10.31234/osf.io/w6z79)
- Jeung, S., Cockx, H., Appelhoff, S., Berg, T., Gramann, K., Grothkopp, S., Warmerdam, E., Hansen, C.,
Oostenveld, R., BIDS maintainers, Welzel, J. (2023).
**Motion-BIDS: extending the Brain Imaging Data Structure specification to organize motion data for reproducible research**.
PsyArXiv.
[doi:10.31234/osf.io/w6z79](https://doi.org/10.31234/osf.io/w6z79)

#### MRS

Expand Down
1 change: 0 additions & 1 deletion src/longitudinal-and-multi-site-studies.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ Apps and everything should just work.
Alternatively you can combine data from all sites into one dataset.
This can be done in two ways:


#### Option 2.a: Collate sites at subject level

To identify which site each subjects comes from you can add a `site` column in the
Expand Down
6 changes: 0 additions & 6 deletions src/modality-agnostic-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -545,9 +545,3 @@ code organization of these scripts at the moment.
<!-- Link Definitions -->

[bids uris]: ./common-principles.md#bids-uri

[object]: https://www.json.org/json-en.html

[string]: https://www.w3schools.com/js/js_json_datatypes.asp

[uri]: ./common-principles.md#uniform-resource-indicator

0 comments on commit 9c9591e

Please sign in to comment.