Skip to content

Commit 0d6f61a

Browse files
committed
fix paths in doc [skip CI]
1 parent 4b295a8 commit 0d6f61a

File tree

1 file changed

+51
-52
lines changed

1 file changed

+51
-52
lines changed

README.md

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ The Freesurfer reconstruction should be performed with the
6060
Performs the three steps (prep, bedp, path) of Tracula's `trac-all`,
6161
reconstructing major fiber tracts form Freesurfer outputs and
6262
DWI raw data.
63-
All data is written into *<output_dir>*.
63+
All data is written into `{output_dir}`.
6464

6565
- **group1**: Motion statistics
6666

6767
Collects motion statistics for multiple subjects into one file.
6868
Additionally, total motion index (TMI, according to
6969
[Yendiki et al., 2013](http://doi.org/10.1016/j.neuroimage.2013.11.027)).
7070
Output is written to
71-
*<output_dir>/00_group1_motion_stats/group_motion.tsv*.
71+
`*{output_dir}/00_group1_motion_stats/group_motion.tsv`.
7272

7373
*Note*: In deviation to the original equation
7474
(which includes rotation, translation, bad slices, dropout score),
@@ -84,59 +84,58 @@ The Freesurfer reconstruction should be performed with the
8484
Collects characteristics of a tract (average FA...)
8585
for multiple subjects.
8686
Output is written to
87-
*<output_dir>/00_group2_tract_stats/<tract_name>_stats.tsv*.
87+
`{output_dir}/00_group2_tract_stats/{tract_name}_stats.tsv`.
8888

8989

9090
### Usage
9191
This App has the following command line arguments:
9292

93-
usage: phys.py [-h] --license_key LICENSE_KEY
94-
[--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]]
95-
[--freesurfer_dir FREESURFER_DIR]
96-
[--stages {prep,bedp,path,all} [{prep,bedp,path,all} ...]] [-v]
97-
bids_dir output_dir {participant,group1,group2}
98-
99-
BIDS App for Tracula processing stream.
100-
https://surfer.nmr.mgh.harvard.edu/fswiki/Tracula
101-
102-
positional arguments:
103-
bids_dir The directory with the input dataset formatted
104-
according to the BIDS standard.
105-
output_dir The directory where the output files should be stored.
106-
If you are running group level analysis this folder
107-
should be prepopulated with the results of
108-
theparticipant level analysis.
109-
{participant,group1,group2}
110-
Level of the analysis that will be performed.
111-
"participant": reconstructs paths (trac-all -prep,
112-
-bedp and -path), "group1": collects motion stats in
113-
one file, "group2": collects single subject overall
114-
path stats in one file.
115-
116-
optional arguments:
117-
-h, --help show this help message and exit
118-
--license_key LICENSE_KEY
119-
FreeSurfer license key - letters and numbers after "*"
120-
in the email you received after registration. To
121-
register (for free) visit
122-
https://surfer.nmr.mgh.harvard.edu/registration.html
123-
(default: None)
124-
--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]
125-
The label of the participant that should be analyzed.
126-
The label corresponds to sub-<participant_label> from
127-
the BIDS spec (so it does not include "sub-"). If this
128-
parameter is not provided all subjects should be
129-
analyzed. Multiple participants can be specified with
130-
a space separated list. (default: None)
131-
--freesurfer_dir FREESURFER_DIR
132-
The directory with the freesurfer data. If not
133-
specified, output_dir is assumed to be populated with
134-
freesurfer data. (default: None)
135-
--stages {prep,bedp,path,all} [{prep,bedp,path,all} ...]
136-
Participant-level trac-all stages to run. Passing "all" will
137-
run "prep", "bedp" and "path". (default: ['all'])
138-
-v, --version show program's version number and exit
139-
93+
usage: run.py [-h] --license_key LICENSE_KEY
94+
[--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]]
95+
[--freesurfer_dir FREESURFER_DIR]
96+
[--stages {prep,bedp,path,all} [{prep,bedp,path,all} ...]] [-v]
97+
bids_dir output_dir {participant,group1,group2}
98+
99+
BIDS App for Tracula processing stream.
100+
https://surfer.nmr.mgh.harvard.edu/fswiki/Tracula
101+
102+
positional arguments:
103+
bids_dir The directory with the input dataset formatted
104+
according to the BIDS standard.
105+
output_dir The directory where the output files should be stored.
106+
If you are running group level analysis this folder
107+
should be prepopulated with the results of
108+
theparticipant level analysis.
109+
{participant,group1,group2}
110+
Level of the analysis that will be performed.
111+
"participant": reconstructs paths (trac-all -prep,
112+
-bedp and -path), "group1": collects motion stats in
113+
one file, "group2": collects single subject overall
114+
path stats in one file.
115+
116+
optional arguments:
117+
-h, --help show this help message and exit
118+
--license_key LICENSE_KEY
119+
FreeSurfer license key - letters and numbers after "*"
120+
in the email you received after registration. To
121+
register (for free) visit
122+
https://surfer.nmr.mgh.harvard.edu/registration.html
123+
(default: None)
124+
--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]
125+
The label of the participant that should be analyzed.
126+
The label corresponds to sub-<participant_label> from
127+
the BIDS spec (so it does not include "sub-"). If this
128+
parameter is not provided all subjects should be
129+
analyzed. Multiple participants can be specified with
130+
a space separated list. (default: None)
131+
--freesurfer_dir FREESURFER_DIR
132+
The directory with the freesurfer data. If not
133+
specified, output_dir is assumed to be populated with
134+
freesurfer data. (default: None)
135+
--stages {prep,bedp,path,all} [{prep,bedp,path,all} ...]
136+
Participant-level trac-all stages to run. Passing"all"
137+
will run "prep", "bedp" and "path". (default: ['all'])
138+
-v, --version show program's version number and exit
140139

141140

142141
##
@@ -154,9 +153,9 @@ To run it in participant level mode (for one participant):
154153
--freesurfer_dir /freesurfer
155154

156155
**Note that** the path specified in --freesurfer_dir needs to be the
157-
mount point inside the docker container (e.g., */freesurfer*, specified
156+
mount point inside the docker container (e.g., `/freesurfer`, specified
158157
in the 4th line of the previous command, after the ":"), not the
159-
path on your hard drive (e.g., */data/ds114/derivates/freesurfer*)
158+
path on your hard drive (e.g., `/data/ds114/derivates/freesurfer`)
160159

161160
#### Group level
162161

0 commit comments

Comments
 (0)