Merge pull request #40 from richford/cli-params

Cli params for eddy_niter and slice_outlier_threshold

Author: akeshavan

dmriprep/cli.py

@@ -10,24 +10,40 @@
 
 
 @click.command()
-@click.option('--participant-label', help="The label(s) of the participant(s) that should be"
-                                           "analyzed. The label corresponds to"
-                                           "sub-<participant_label> from the BIDS spec (so it does"
-                                           "not include 'sub-'). If this parameter is not provided"
-                                           "all subjects will be analyzed. Multiple participants"
-                                           "can be specified with a space separated list.",
-              default=None
-              )
+@click.option('--participant-label',
+              help="The label(s) of the participant(s) that should be"
+                   "analyzed. The label corresponds to"
+                   "sub-<participant_label> from the BIDS spec (so it does"
+                   "not include 'sub-'). If this parameter is not provided"
+                   "all subjects will be analyzed. Multiple participants"
+                   "can be specified with a space separated list.",
+              default=None)
+@click.option('--eddy-niter',
+              help="Fixed number of eddy iterations. See "
+                   "https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/eddy/UsersGuide"
+                   "#A--niter",
+              default=5, type=(int))
+@click.option('--slice-outlier-threshold',
+              help="Number of allowed outlier slices per volume. "
+                   "If this is exceeded the volume is dropped from analysis. "
+                   "If an int is provided, it is treated as number of allowed "
+                   "outlier slices. If a float between 0 and 1 "
+                   "(exclusive) is provided, it is treated the fraction of "
+                   "allowed outlier slices.",
+              default=0.02)
 @click.argument('bids_dir',
                 )
 @click.argument('output_dir',
                 )
 @click.argument('analysis_level',
                 type=click.Choice(['participant', 'group']),
                 default='participant')
-def main(participant_label, bids_dir, output_dir, analysis_level="participant"):
+def main(participant_label, bids_dir, output_dir,
+         eddy_niter=5, slice_outlier_threshold=0.02,
+         analysis_level="participant"):
     """
-    BIDS_DIR: The directory with the input dataset formatted according to the BIDS standard.
+    BIDS_DIR: The directory with the input dataset formatted according to
+    the BIDS standard.
 
     OUTPUT_DIR: The directory where the output files should be stored.
     If you are running a group level analysis, this folder
@@ -38,16 +54,18 @@ def main(participant_label, bids_dir, output_dir, analysis_level="participant"):
     participant level analyses can be run independently
     (in parallel).
     """
-
     if analysis_level is not 'participant':
-        raise NotImplementedError('The only valid analysis level for dmriprep is participant at the moment.')
+        raise NotImplementedError('The only valid analysis level for dmriprep '
+                                  'is participant at the moment.')
 
     inputs = io.get_bids_files(participant_label, bids_dir)
 
     for subject_inputs in inputs:
         run.run_dmriprep_pe(**subject_inputs,
                             working_dir=os.path.join(output_dir, 'scratch'),
-                            out_dir=output_dir)
+                            out_dir=output_dir,
+                            eddy_niter=eddy_niter,
+                            slice_outlier_threshold=slice_outlier_threshold)
 
     return 0