jstout211 / enigma_MEG

Other
9 stars 1 forks source link

Set up argparse option blocks #37

Closed jstout211 closed 1 year ago

jstout211 commented 1 year ago

Better organize argparse so that required and common options are listed together

jstout211 commented 1 year ago

These can be renamed / reorganized, but the template is there:

options:
  -h, --help            show this help message and exit
  -remove_old           If flag is present, remove any files from a prior run (excepting freesurfer ddata).

Standard Inputs:
  -bids_root BIDS_ROOT  Top level directory of the bids data
  -subject SUBJECT      BIDS ID of subject to process
  -subjects_dir SUBJECTS_DIR
                        Freesurfer subjects directory, only specify if not bids_root/derivatives/freesurfer/subjects
  -fs_subject FS_SUBJECT
                        Freefurfer subject ID if different from BIDS ID
  -run RUN              Run number. NOTE: 01 is different from 1
  -session SESSION
  -mains MAINS          Electric mains frequency (50 or 60)
  -rest_tag REST_TAG    Override in case task name is other than rest for example - resteyesopen
  -emptyroom_tag EMPTYROOM_TAG
                        Override in case emptryoom is other than emptyroom. In case of no emptyroom, set as None on cmdline
  -n_jobs N_JOBS        number of jobs to run concurrently for multithreaded operations

Inputs from a CSV:
  -proc_fromcsv PROC_FROMCSV
                        Loop over all subjects in the bids_root and process. Requires CSV file with processing manifest

Alternative Inputs:
  -fs_ave_fids          If no fiducials have been localized to the mri manually, this provides a coarse fit from the ave brain which is fine tuned with the headshape. This is less acurate than a manually
                        assessed fid placement
  -do_dics              If flag is present, do a DICS beamformer. Otherwise, do lcmv.

QA Inputs:
  -ica_manual_qa_prep   if flag is present, stop after ICA for manual QA
  -process_manual_ica_qa
                        If flag is present, pick up analysis after performing manual ICA QA