Skip to content

[FIX] Correct typos and formatting in specification documents #2253

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[FIX] Correct typos and formatting in specification documents #2253

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion src/CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
- \[FIX] Add misssing files in filename template for NIRS [1716](https://github.com/bids-standard/bids-specification/pull/1716) ([Remi-Gau](https://github.com/Remi-Gau))
- \[FIX] Remove task entity from DWI and PERF time series file templates [1703](https://github.com/bids-standard/bids-specification/pull/1703) ([Remi-Gau](https://github.com/Remi-Gau))
- \[FIX] Add `part-<value>` to the PEPOLAR fieldmaps [1685](https://github.com/bids-standard/bids-specification/pull/1685) ([oesteban](https://github.com/oesteban))
- \[INFRA] Publish schema to Javascript Registry (https://jsr.io/@bids/schema) on changes and releases [1899](https://github.com/bids-standard/bids-specification/pull/1899) ([effigies](https://github.com/effigies))
- \[INFRA] Publish schema to Javascript Registry (<https://jsr.io/@bids/schema>) on changes and releases [1899](https://github.com/bids-standard/bids-specification/pull/1899) ([effigies](https://github.com/effigies))
- \[INFRA] Introduce metaschema [1787](https://github.com/bids-standard/bids-specification/pull/1787) ([bendichter](https://github.com/bendichter))
- \[MISC] Restructure MEG empty room example texts [1677](https://github.com/bids-standard/bids-specification/pull/1677) ([guiomar](https://github.com/guiomar))

Expand Down
30 changes: 15 additions & 15 deletions src/appendices/meg-systems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ Preferred names of MEG systems comprise restricted keywords for Manufacturer fie

Restricted keywords for ManufacturersModelName field in the `*_meg.json` file:

| **System Model Name** | **Manufacturer** | **Details** |
| ------------------------- | --------- ----------- | -------------------------------------------------------------------------------------------- |
| CTF-64 | CTF | |
| CTF-151 | CTF | [https://www.ctf.com/products](https://www.ctf.com/products) |
| CTF-275 | CTF | CTF-275: OMEGA 2000 |
| Neuromag-122 | Neuromag/Elekta/Megin | |
| ElektaVectorview | Neuromag/Elekta/Megin | 102 magnetometers + 204 planar gradiometers |
| ElektaTRIUX | Neuromag/Elekta/Megin | [https://www.elekta.com/products/neurosurgery/](https://www.elekta.com/products/neurosurgery/) |
| 4D-Magnes-WH2500 | BTi/4D | |
| 4D-Magnes-WH3600 | BTi/4D | |
| KIT-157 | KIT/Yokogawa | |
| KIT-160 | KIT/Yokogawa | |
| KIT-208 | KIT/Yokogawa | |
| ITAB-ARGOS153 | ITAB | |
| Aalto-MEG-MRI-YYYY/MM | Aalto/MEG-MRI | YYYY-MM (year, month; or major version) |
| **System Model Name** | **Manufacturer** | **Details** |
| --------------------- | --------------------- | ----------------------------------------------- |
| CTF-64 | CTF | |
| CTF-151 | CTF | <https://www.ctf.com/products> |
| CTF-275 | CTF | CTF-275: OMEGA 2000 |
| Neuromag-122 | Neuromag/Elekta/Megin | |
| ElektaVectorview | Neuromag/Elekta/Megin | 102 magnetometers + 204 planar gradiometers |
| ElektaTRIUX | Neuromag/Elekta/Megin | <https://www.elekta.com/products/neurosurgery/> |
| 4D-Magnes-WH2500 | BTi/4D | |
| 4D-Magnes-WH3600 | BTi/4D | |
| KIT-157 | KIT/Yokogawa | |
| KIT-160 | KIT/Yokogawa | |
| KIT-208 | KIT/Yokogawa | |
| ITAB-ARGOS153 | ITAB | |
| Aalto-MEG-MRI-YYYY/MM | Aalto/MEG-MRI | YYYY-MM (year, month; or major version) |
8 changes: 4 additions & 4 deletions src/common-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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)
- REQUIRED: Data cannot 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

Expand Down Expand Up @@ -93,7 +93,7 @@ be reviewed to include common data types in the future releases of the BIDS
specification.

It is RECOMMENDED that non-compulsory metadata fields (like `notch` in `channels.tsv` files)
and/or files (like `events.tsv`) are fully omitted *when they are unavailable or unapplicable*,
and/or files (like `events.tsv`) are fully omitted *when they are unavailable or inapplicable*,
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).

Expand Down Expand Up @@ -631,7 +631,7 @@ Rules for formatting plain-text tabular files apply to TSVGZ files with three ex
!!! warning "Attention"

In contrast to plain-text TSV files,
compressed tabular files files MUST NOT include a header line.
compressed tabular files MUST NOT include a header line.
Column names MUST be provided in the JSON file with the
[`Columns`](glossary.md#columns-metadata) field.
Each column MAY additionally be described with a column description,
Expand Down Expand Up @@ -1067,7 +1067,7 @@ Describing dates and timestamps:
- Dates can be shifted by a random number of days for privacy protection
reasons.
To distinguish real dates from shifted dates,
is is RECOMMENDED to set shifted dates to the year 1925 or earlier.
it is RECOMMENDED to set shifted dates to the year 1925 or earlier.
Note that some data formats do not support arbitrary recording dates.
For example, the [EDF](https://www.edfplus.info/)
data format can only contain recording dates after 1985.
Expand Down
2 changes: 1 addition & 1 deletion src/schema/objects/entities.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ inversion:
If files belonging to an entity-linked file collection are acquired at different inversion times,
the `inv-<index>` entity MUST be used to distinguish individual files.

This entity represents the `"InversionTime` metadata field.
This entity represents the `"InversionTime"` metadata field.
Therefore, if the `inv-<index>` entity is present in a filename,
`"InversionTime"` MUST be defined in the associated metadata.
Please note that the `<index>` denotes the number/index (in the form of a nonnegative integer),
Expand Down
1 change: 1 addition & 0 deletions src/schema/rules/checks/deprecations.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
AnatomicalLandmarkCoordinateSystemDeprecation:
issue:
code: ELEKTA_NEUROMAG_DEPRECATED
Expand Down