Skip to content

Commit 520a1f4

Browse files
committed
Minor doc tweaks
1 parent 182eceb commit 520a1f4

File tree

3 files changed

+10
-33
lines changed

3 files changed

+10
-33
lines changed

docs/bidsapps.rst

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ BIDS-apps
33

44
Metadata editing
55
----------------
6-
If you have a previously converted BIDS data repository and you would like to retrospectively change or replace one or more metadata fields in the json sidecar files you can use ``fixmeta``. Fixmeta is more powerful than conventional find-and-replace tools in that fixmeta can leverage BIDScoin's `special bidsmap features <./bidsmap.html#special-bidsmap-features>`__
7-
8-
::
6+
If you have a previously converted BIDS data repository and you would like to retrospectively change or replace one or more metadata fields in the json sidecar files you can use ``fixmeta``. Fixmeta is more powerful than conventional find-and-replace tools in that fixmeta can leverage BIDScoin's `special bidsmap features <./bidsmap.html#special-bidsmap-features>`__::
97

108
usage: fixmeta [-h] [-p PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]] [-b BIDSMAP]
119
bidsfolder pattern metadata
@@ -44,9 +42,7 @@ If you have a previously converted BIDS data repository and you would like to re
4442
Multi-echo combination
4543
----------------------
4644

47-
Before sharing or pre-processing their images, you may want to combine the separate the individual echos of multi-echo MRI acquisitions. The ``echcombine``-tool is a wrapper around ``mecombine`` that writes BIDS valid echo-combined output data.
48-
49-
::
45+
Before sharing or pre-processing their images, you may want to combine the separate the individual echos of multi-echo MRI acquisitions. The ``echcombine``-tool is a wrapper around ``mecombine`` that writes BIDS valid echo-combined output data.::
5046

5147
usage: echocombine [-h] [-p PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]] [-o OUTPUT]
5248
[-a {PAID,TE,average}] [-w [WEIGHTS ...]] [-f]
@@ -94,9 +90,7 @@ Before sharing or pre-processing their images, you may want to combine the separ
9490
Defacing
9591
--------
9692

97-
Before sharing or pre-processing your data, you may want to deface your anatomical MRI scans to protect the privacy of your participants. The ``deface``-tool is a wrapper around `pydeface <https://github.com/poldracklab/pydeface>`__ that writes BIDS valid defaced output images. NB: pydeface requires `FSL <https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FslInstallation>`__ to be installed on the system.
98-
99-
::
93+
Before sharing or pre-processing your data, you may want to deface your anatomical MRI scans to protect the privacy of your participants. The ``deface``-tool is a wrapper around `pydeface <https://github.com/poldracklab/pydeface>`__ that writes BIDS valid defaced output images. NB: pydeface requires `FSL <https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FslInstallation>`__ to be installed on the system.::
10094

10195
usage: deface [-h] [-p PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]] [-o OUTPUT] [-c] [-n NATIVESPEC]
10296
[-a ARGS] [-f]
@@ -149,9 +143,7 @@ Before sharing or pre-processing your data, you may want to deface your anatomic
149143
Multi-echo defacing
150144
-------------------
151145

152-
This utility is very similar to the `deface <#defacing>`__ utility above, except that it can handle multi-echo data.
153-
154-
::
146+
This utility is very similar to the `deface <#defacing>`__ utility above, except that it can handle multi-echo data.::
155147

156148
usage: medeface [-h] [-m MASKPATTERN] [-p PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]] [-o OUTPUT] [-c]
157149
[-n NATIVESPEC] [-a ARGS] [-f]
@@ -210,9 +202,7 @@ This utility is very similar to the `deface <#defacing>`__ utility above, except
210202
Skull-stripping
211203
---------------
212204

213-
The ``skullstrip``-tool is a wrapper around the synthstrip tool that writes BIDS valid brain extracted output data
214-
215-
::
205+
The ``skullstrip``-tool is a wrapper around the synthstrip tool that writes BIDS valid brain extracted output data::
216206

217207
usage: skullstrip [-h] [-p PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]] [-m MASKED]
218208
[-o OUTPUT [OUTPUT ...]] [-f] [-a ARGS] [-c] [-n NATIVESPEC]
@@ -269,9 +259,7 @@ The ``skullstrip``-tool is a wrapper around the synthstrip tool that writes BIDS
269259
Quality control
270260
---------------
271261

272-
``Slicereport`` is a very flexible QC report generator for doing visual inspections on your BIDS data.
273-
274-
::
262+
``Slicereport`` is a very flexible QC report generator for doing visual inspections on your BIDS data.::
275263

276264
usage: slicereport [-h] [-o OUTLINEPATTERN] [-i OUTLINEIMAGE]
277265
[-p PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]] [-r REPORTFOLDER]

docs/utilities.rst

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ Utilities
44
bidscoin
55
--------
66

7-
The bidscoin command-line utility serves as a central starting point to test and manage your BIDScoin installation
8-
9-
::
7+
The bidscoin command-line utility serves as a central starting point to test and manage your BIDScoin installation::
108

119
usage: bidscoin [-h] [-l] [-p] [-i INSTALL [INSTALL ...]] [-u UNINSTALL [UNINSTALL ...]]
1210
[-d DOWNLOAD] [-t [TEST]] [-b BIDSMAPTEST] [-c CREDITS [CREDITS ...]]
@@ -65,9 +63,7 @@ The bidscoin command-line utility serves as a central starting point to test and
6563
dicomsort
6664
---------
6765

68-
The ``dicomsort`` command-line tool is a utility to move your flat- or DICOMDIR-organized files (see `above <#required-source-data-structure>`__) into a 'seriesfolder' organization. This can be useful to organize your source data in a more convenient and human readable way (DICOMDIR or flat DICOM directories can often be hard to comprehend). The BIDScoin tools will run dicomsort in a temporary folder if your data is not already organized in series-folders, so in principle you don't really need to run it yourself (unless when you have a single multi-subject DICOMDIR file for your entire repository). Running dicomsort beforehand does, however, give you more flexibility in handling special cases that are not handled properly and it can also give you a speed benefit. If dicomsort do not satisfy your needs, then have a look at this `DICOM reorganize <https://github.com/robertoostenveld/bids-tools/blob/master/doc/reorganize_dicom_files.md>`__ tool.
69-
70-
::
66+
The ``dicomsort`` command-line tool is a utility to move your flat- or DICOMDIR-organized files (see `above <#required-source-data-structure>`__) into a 'seriesfolder' organization. This can be useful to organize your source data in a more convenient and human readable way (DICOMDIR or flat DICOM directories can often be hard to comprehend). The BIDScoin tools will run dicomsort in a temporary folder if your data is not already organized in series-folders, so in principle you don't really need to run it yourself (unless when you have a single multi-subject DICOMDIR file for your entire repository). Running dicomsort beforehand does, however, give you more flexibility in handling special cases that are not handled properly and it can also give you a speed benefit. If dicomsort do not satisfy your needs, then have a look at this `DICOM reorganize <https://github.com/robertoostenveld/bids-tools/blob/master/doc/reorganize_dicom_files.md>`__ tool.::
7167

7268
usage: dicomsort [-h] [-i SUBPREFIX] [-j SESPREFIX] [-f FOLDERSCHEME] [-n NAMESCHEME] [-p PATTERN]
7369
[--force] [-d]
@@ -121,9 +117,7 @@ The ``dicomsort`` command-line tool is a utility to move your flat- or DICOMDIR-
121117
rawmapper
122118
---------
123119

124-
Another command-line utility that can be helpful in organizing your source data is ``rawmapper``. This utility can show you an overview (map) of all the values of DICOM-attributes of interest in your data-set and, optionally, used to rename your source data sub-folders. The latter option can be handy e.g. if you manually entered subject-identifiers as [Additional info] at the scanner console and you want to use these to rename your subject folders.
125-
126-
::
120+
Another command-line utility that can be helpful in organizing your source data is ``rawmapper``. This utility can show you an overview (map) of all the values of DICOM-attributes of interest in your data-set and, optionally, used to rename your source data sub-folders. The latter option can be handy e.g. if you manually entered subject-identifiers as [Additional info] at the scanner console and you want to use these to rename your subject folders.::
127121

128122
usage: rawmapper [-h] [-s SESSIONS [SESSIONS ...]] [-f FIELD [FIELD ...]] [-w WILDCARD]
129123
[-o OUTFOLDER] [-r] [-c] [-n SUBPREFIX] [-m [SESPREFIX]] [-d]
@@ -178,9 +172,7 @@ Another command-line utility that can be helpful in organizing your source data
178172
bidsparticipants
179173
----------------
180174

181-
The bidsparticipants tool is useful for (re-)generating a participants.tsv file from your source data (without having to run bidscoiner)
182-
183-
::
175+
The bidsparticipants tool is useful for (re-)generating a participants.tsv file from your source data (without having to run bidscoiner)::
184176

185177
usage: bidsparticipants [-h] [-k KEYS [KEYS ...]] [-d] [-b BIDSMAP] sourcefolder bidsfolder
186178

docs/workflow.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ If you add new subjects all you need to do is re-run the bidscoiner -- unless th
2121

2222
Step 1a: Running the bidsmapper
2323
-------------------------------
24-
2524
::
2625

2726
usage: bidsmapper [-h] [-b BIDSMAP] [-t TEMPLATE] [-p PLUGINS [PLUGINS ...]] [-n SUBPREFIX]
@@ -94,7 +93,6 @@ After the source data has been scanned, the bidsmapper will automatically launch
9493

9594
Step 1b: Running the bidseditor
9695
-------------------------------
97-
9896
::
9997

10098
usage: bidseditor [-h] [-b BIDSMAP] [-t TEMPLATE] bidsfolder
@@ -176,7 +174,6 @@ Field maps are typically acquired to be applied to specific other scans from the
176174

177175
Step 2: Running the bidscoiner
178176
------------------------------
179-
180177
::
181178

182179
usage: bidscoiner [-h] [-p PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]] [-b BIDSMAP] [-f] [-c]

0 commit comments

Comments
 (0)