Skip to content

Commit 42ad1ba

Browse files
committed
DOC: Update documentation to reflect --age-months deprecation [skip ci]
1 parent 5306391 commit 42ad1ba

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

docs/usage.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,19 @@ The input dataset is required to be in valid
88
{abbr}`BIDS (The Brain Imaging Data Structure)` format,
99
and it must include at least one T1-weighted and
1010
one T2-weighted structural image and
11-
(unless disabled with a flag) a BOLD series.
11+
a BOLD series (unless using the `--anat-only` flag).
12+
1213
We highly recommend that you validate your dataset with the free, online
1314
[BIDS Validator](http://bids-standard.github.io/bids-validator/).
1415

15-
The exact command to run *NiBabies* depends on the [Installation](./installation.md) method.
16-
The common parts of the command follow the
17-
[BIDS-Apps](https://github.com/BIDS-Apps) definition.
18-
Example:
19-
20-
```Shell
21-
$ nibabies data/bids_root/ out/ participant -w work/ --participant-id 01 --age-months 12
22-
```
16+
### Participant Ages
17+
*NiBabies* will attempt to automatically extract participant ages (in months) from the BIDS layout.
18+
Specifically, these two files will be checked:
19+
- [Sessions file](https://bids-specification.readthedocs.io/en/stable/03-modality-agnostic-files.html#sessions-file): `<bids-root>/<subject>/subject_sessions.tsv`
20+
- [Participants file](https://bids-specification.readthedocs.io/en/stable/03-modality-agnostic-files.html#participants-file): `<bids-root>/participants.tsv`
2321

24-
Further information about BIDS and BIDS-Apps can be found at the
25-
[NiPreps portal](https://www.nipreps.org/apps/framework/).
22+
Either file should include `age` (or if you wish to be more explicit: `age_months`) columns, and it is
23+
recommended to have an accompanying JSON file to further describe these fields, and explicitly state the values are in months.
2624

2725
## The FreeSurfer license
2826

@@ -33,6 +31,21 @@ To obtain a FreeSurfer license, simply register for free at https://surfer.nmr.m
3331
FreeSurfer will search for a license key file first using the `$FS_LICENSE` environment variable and then in the default path to the license key file (`$FREESURFER_HOME`/license.txt). If `$FS_LICENSE` is set, the [`nibabies-wrapper`](#using-the-nibabies-wrapper) will automatically handle setting the license within the container.
3432
Otherwise, you will need to use the `--fs-license-file` flag to ensure the license is available.
3533

34+
35+
## Example command
36+
37+
The exact command to run *NiBabies* depends on the [Installation](./installation.md) method.
38+
The common parts of the command follow the
39+
[BIDS-Apps](https://github.com/BIDS-Apps) definition.
40+
Example:
41+
42+
```Shell
43+
$ nibabies data/bids_root/ out/ participant -w work/ --participant-id 01
44+
```
45+
46+
Further information about BIDS and BIDS-Apps can be found at the
47+
[NiPreps portal](https://www.nipreps.org/apps/framework/).
48+
3649
## Command-Line Arguments
3750
```{argparse}
3851
:ref: nibabies.cli.parser._build_parser
@@ -50,21 +63,9 @@ At minimum, the following *positional* arguments are required.
5063

5164
However, as infant brains can vastly differ depending on age, providing the following arguments is highly recommended:
5265

53-
- **`--age-months`** - participant age in months
54-
55-
:::{admonition} Warning
56-
:class: warning
57-
58-
This is required if FreeSurfer is not disabled (`--fs-no-reconall`)
59-
:::
60-
6166
- **`--participant-id`** - participant ID
6267

63-
:::{admonition} Tip
64-
:class: tip
65-
66-
This is recommended when using `--age-months` if age varies across participants.
67-
:::
68+
- **`--session-id`** - session ID
6869

6970
- **`--segmentation-atlases-dir`** - directory containing pre-labeled segmentations to use for Joint Label Fusion.
7071

@@ -85,11 +86,11 @@ For installation instructions, please see [](installation.md#installing-the-niba
8586
### Sample Docker usage
8687

8788
```
88-
$ nibabies-wrapper docker /path/to/data /path/to/output participant --age-months 12 --fs-license-file /usr/freesurfer/license.txt
89+
$ nibabies-wrapper docker /path/to/data /path/to/output participant --fs-license-file /usr/freesurfer/license.txt
8990
9091
RUNNING: docker run --rm -e DOCKER_VERSION_8395080871=20.10.6 -it -v /path/to/data:/data:ro \
9192
-v /path/to/output:/out -v /usr/freesurfer/license.txt:/opt/freesurfer/license.txt:ro \
92-
nipreps/nibabies:21.0.0 /data /out participant --age-months 12
93+
nipreps/nibabies:23.0.0 /data /out participant
9394
...
9495
```
9596

@@ -103,11 +104,11 @@ This can be overridden by using the `-i` flag to specify a particular Docker ima
103104
### Sample Singularity usage
104105

105106
```
106-
$ nibabies-wrapper singularity /path/to/data /path/to/output participant --age-months 12 -i nibabies-21.0.0.sif --fs-license-file /usr/freesurfer/license.txt
107+
$ nibabies-wrapper singularity /path/to/data /path/to/output participant -i nibabies-23.0.0.sif --fs-license-file /usr/freesurfer/license.txt
107108
108109
RUNNING: singularity run --cleanenv -B /path/to/data:/data:ro \
109110
-B /path/to/output:/out -B /usr/freesurfer/license.txt:/opt/freesurfer/license.txt:ro \
110-
nibabies-21.0.0.sif /data /out participant --age-months 12
111+
nibabies-23.0.0.sif /data /out participant
111112
...
112113
```
113114

0 commit comments

Comments
 (0)