From 352d9b73c2246230855c6644d3fdade736fddfe2 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Thu, 9 Jan 2025 19:43:44 +0100 Subject: [PATCH] fix some remark warnings --- src/common-principles.md | 9 ++++++--- src/introduction.md | 10 +++++----- src/longitudinal-and-multi-site-studies.md | 1 - src/modality-agnostic-files.md | 6 ------ 4 files changed, 11 insertions(+), 15 deletions(-) diff --git a/src/common-principles.md b/src/common-principles.md index 9c2ff6c9f1..102cac6c89 100644 --- a/src/common-principles.md +++ b/src/common-principles.md @@ -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. @@ -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. @@ -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" diff --git a/src/introduction.md b/src/introduction.md index a07b654b2c..c997350f42 100644 --- a/src/introduction.md +++ b/src/introduction.md @@ -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 diff --git a/src/longitudinal-and-multi-site-studies.md b/src/longitudinal-and-multi-site-studies.md index 48960366ef..6fe102cb1a 100644 --- a/src/longitudinal-and-multi-site-studies.md +++ b/src/longitudinal-and-multi-site-studies.md @@ -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 diff --git a/src/modality-agnostic-files.md b/src/modality-agnostic-files.md index b88c264856..93b7eccac7 100644 --- a/src/modality-agnostic-files.md +++ b/src/modality-agnostic-files.md @@ -545,9 +545,3 @@ code organization of these scripts at the moment. [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