From 927c4fa9e68319e28da1d835a4bf3d410369ab89 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Tue, 19 Sep 2023 23:38:05 -0400 Subject: [PATCH] format --- src/CONTRIBUTING.md | 26 +++++++++++++------------- src/specification.md | 22 +++++++++++----------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/CONTRIBUTING.md b/src/CONTRIBUTING.md index 576eb7d..19cb843 100644 --- a/src/CONTRIBUTING.md +++ b/src/CONTRIBUTING.md @@ -2,19 +2,19 @@ ## Extension leads -- Christopher J Markiewicz [markiewicz@stanford.edu](mailto:markiewicz@stanford.edu) -- Gregory Kiar [gregory.kiar@childmind.org](mailto:gregory.kiar@childmind.org) +- Christopher J Markiewicz [markiewicz@stanford.edu](mailto:markiewicz@stanford.edu) +- Gregory Kiar [gregory.kiar@childmind.org](mailto:gregory.kiar@childmind.org) ## Contributors -- Tristan Glatard: [tristan.glatard@concordia.ca](mailto:tristan.glatard@concordia.ca) -- Pierre Rioux: [pierre.rioux@mcgill.ca](mailto:pierre.rioux@mcgill.ca) -- Yaroslav O. Halchenko [yoh@dartmouth.edu](mailto:yoh@dartmouth.edu) -- Eric Earl [eric.earl@nih.gov](mailto:eric.earl@nih.gov) -- Pradeep Reddy Raamana raamanap@pitt.edu -- Aki Nikolaidis [aki.nikolaidis@childmind.org](mailto:aki.nikolaidis@childmind.org) -- Guiomar Niso [guiomar.niso@ctb.upm.es](mailto:guiomar.niso@ctb.upm.es), -- Lennart Walger [lennart.walger@ukbonn.de](mailto:lennart.walger@ukbonn.de) -- Sebastien Tourbier [sebastien.tourbier1@gmail.com](mailto:sebastien.tourbier1@gmail.com) -- Alejandro de la Vega [delavega@utexas.edu](mailto:delavega@utexas.edu) -- Robert Luke robert.luke@mq.edu.au +- Tristan Glatard: [tristan.glatard@concordia.ca](mailto:tristan.glatard@concordia.ca) +- Pierre Rioux: [pierre.rioux@mcgill.ca](mailto:pierre.rioux@mcgill.ca) +- Yaroslav O. Halchenko [yoh@dartmouth.edu](mailto:yoh@dartmouth.edu) +- Eric Earl [eric.earl@nih.gov](mailto:eric.earl@nih.gov) +- Pradeep Reddy Raamana raamanap@pitt.edu +- Aki Nikolaidis [aki.nikolaidis@childmind.org](mailto:aki.nikolaidis@childmind.org) +- Guiomar Niso [guiomar.niso@ctb.upm.es](mailto:guiomar.niso@ctb.upm.es), +- Lennart Walger [lennart.walger@ukbonn.de](mailto:lennart.walger@ukbonn.de) +- Sebastien Tourbier [sebastien.tourbier1@gmail.com](mailto:sebastien.tourbier1@gmail.com) +- Alejandro de la Vega [delavega@utexas.edu](mailto:delavega@utexas.edu) +- Robert Luke robert.luke@mq.edu.au diff --git a/src/specification.md b/src/specification.md index b69d650..25857ec 100644 --- a/src/specification.md +++ b/src/specification.md @@ -59,7 +59,7 @@ BIDS-Derivatives specification. Please refer to general BIDS specification document for context and general guidelines (definitions, units, directory structure, missing values, stimulus -and event information, etc.): +and event information and so on): [https://bids-specification.readthedocs.io/en/stable/](https://bids-specification.readthedocs.io/en/stable/) The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", @@ -124,7 +124,7 @@ A uniform user interface is essential to scalable deployment of BIDS Applications. This section describes the common interface components that may be relied upon by users or platforms running these applications (callers). Command-line interfaces map between positional or flag arguments provided -through an interactive shell program (e.g. Bash) to a program and program +through an interactive shell program (for example Bash) to a program and program behavior. However, tools written in different languages or following different conventions may represent and parse these arguments distinctly. For the purposes of automated execution of diverse tools, a more useful interface is a mapping of @@ -137,7 +137,7 @@ other utilities. The Boutiques toolkit, named bosh, will be referred to when discussing examples throughout this specification. Instead of requiring specific positional arguments and flags which assign common -names to expected options (e.g., "subject-label") in the command-line interfaces +names to expected options (for example "subject-label") in the command-line interfaces themselves, BIDS Applications should provide a Boutiques descriptor — a standardized JSON file that describes the command line behavior and operation of a tool — that map the tool-specific common arguments to these common names, @@ -280,7 +280,7 @@ BIDS Applications: OutputDataSpecification - OPTIONAL. List. If output data conforms to a standard definition (e.g. NIDM-1.1.0), these data standards may be included as a list of strings. + OPTIONAL. List. If output data conforms to a standard definition (for example NIDM-1.1.0), these data standards may be included as a list of strings. @@ -325,7 +325,7 @@ fields, described fully in list - OPTIONAL. Boolean. Indicates whether or not the input field is a list of inputs. One of {true, false}. If omitted, it will be interpreted as false (e.g., non-list input). + OPTIONAL. Boolean. Indicates whether or not the input field is a list of inputs. One of {true, false}. If omitted, it will be interpreted as false (for example non-list input). @@ -337,7 +337,7 @@ fields, described fully in optional - OPTIONAL. Boolean. Indicates whether or not the input field is required. One of {true, false}. If omitted, will be interpreted as false (e.g. non-optional input). + OPTIONAL. Boolean. Indicates whether or not the input field is required. One of {true, false}. If omitted, will be interpreted as false (for example non-optional input). @@ -355,7 +355,7 @@ fields, described fully in value-key - OPTIONAL. String. String to replace in command-line template string. If specified, this MUST NOT be either a superset or subset of the value-key attribute associated with another object in the descriptor; to ensure this, brackets are typically used (e.g. "[value]"). + OPTIONAL. String. String to replace in command-line template string. If specified, this MUST NOT be either a superset or subset of the value-key attribute associated with another object in the descriptor; to ensure this, brackets are typically used (for example "[value]"). @@ -433,7 +433,7 @@ be expressed in the tool's interface. Argument ID - e.g. CLI Flag + for example CLI Flag Definition @@ -496,7 +496,7 @@ to their associated values in the original application. #### Reserved arguments -The ability to filter BIDS entities (e.g. subject, session, or run) allows for +The ability to filter BIDS entities (for example subject, session, or run) allows for the selection of subsets of datasets. To be extensible as new entities are added to the BIDS specification, the reserved arguments are defined here as a rule which maps to BIDS entities, rather than specifying the moving goalpost of an @@ -534,7 +534,7 @@ Acceptable and equivalent usages: In all cases where such arguments are defined and applied, only files in the BIDS dataset that have a value for the specified entities will be subject to -filtering. That is, if a file does not have a given entity (e.g., entity value +filtering. That is, if a file does not have a given entity (for example entity value for it is <None>), the file will be included. Applications are not required to support these arguments, but MUST NOT assign @@ -735,7 +735,7 @@ open a missing file. In this case, it is RECOMMENDED to use exit code 66 If the dataset is not BIDS-compliant, then the BIDS App MAY fail immediately with exit code 16. -If the dataset contains the required files but is not BIDS-compliant (e.g., a +If the dataset contains the required files but is not BIDS-compliant (for example a "dirty" dataset that has more files than needed), then the BIDS App MAY treat the dataset as valid.