View source for Hoffman2:Scripts:setup subject 3

==Setup_subject script usage==
Setup_subject_3 (also named as setup_subject_bids) is built on top of setup_subject_2. The major goal is to apply BIDs format on the data structure. Besides of using BIDs structure, it added other useful features as well.

Setup_subject_3 has all the functions which exist in setup_subject_2 and works the same way with the same options as setup_subject_2.


===Basic Usage:===
 setup_subject_3 [option] basedir subjectID

basedir is where you want the processed data to be stored in your Hoffman account,

subjectID is the subject folder name which has your subject Dicom data

===Options:===

====Options for both BIDs mode and non-BIDs mode====
 --download hostname,userid,path
download data from Dicom server to you hoffman account
It requires 3 argument, separated by comma(,)
(If you have downloaded the data already, this option is not needed)

  1. hostname - (ccn for ccn Dicom server, bmap for BMC Dicom server). 
  2. userid: Your Dicom server user ID
  3. path: path to your data in dicom server


 -d (or --do) : this option to specify the processing you want to add
After NIFTI convert, these options can be used to run FSL mcflirt, bet and melodic also diag, and mprage.
   mcflirt : run mcflirt 
   bet : run bet
   melodic : run melodic
   diags : run diagnostics
   mprage : process  anatomical scans
   sge: submit the job in batch mode

(Using option diags requires mcflirt, bet and melodic to be processed first)


 -s (or --skip) 
this option to specify the processing you want to skip
   mcflirt : run mcflirt 
   bet : run bet
   melodic : run melodic
   diags : run diagnostics
   mprage : process  anatomical scans
   sge: not using batch mode, which means you need to start interactive mode first before running setup_subject_* command
  

 --spm
Set SPM compatability

====Options for BIDs mode only====
 --bids
BIDs format: specify using BIDs structure to group result files. However this option often being used with --config option to choose configuration file.
Without configuration file, the name conversion might not be correct under BIDs format rule.

 --config FILEPATH/FILENAME
Specifying the BIDs naming configuration file path and name. Users should generate this file based on their data and BIDSs formatting rule. Here's more about the [[BIDs configuration file]].

 --sessdir ses-NN
Specify session directory name. This is for Bids format mode and when the data has multiple sessions. When you want the results all go into a session directory named ses-NN (NN represents session number, e.g. 02)

 --notar 
No compression of dicom/ folder. Normally raw dicom data will be compressed into dicom*.tar.gz at the end of NiFTI convert. With this option, it will not compress.
This option is good when you know you want to run the setup_subject_3 script again and want to save time on compression and decompression of the data.
You should run without this option on the last run so it will save the disk usage.

 --setgrp GROUPNAME
Force the data's group to be set as the GROUPNAME specified. The GROUPNAME need to be an existing valid group name in Hoffman.

===Examples: ===

Load the script module first:
 module load ccnscripts

====NON-BIDs Mode====

======Data Structure======

folder subjectID will be created under basedir the user specified.
Then Dicom Raw data will be under dicom/ folder during NiFTI convert then compressed into dicom.tar.gz
Result of NiFTI convert will be under raw/ folder

 ls basedir/subjectID
 analysis  behav  dicom  notes  raw

======Commands======
Download data and run NIFTI convert
 setup_subject_3 --download ccn,dicomuserid,/dicom/data/YOURGROUP/ basedir subjectID
( /dicom/data/YOURGROUP/subjectID should be where the raw data is located and accessable by your Dicom server user account)

Download data and run NIFTI convert and other FSL processing:
 setup_subject_3 --download ccn,userid,/dicom/data/YOURGROUP/ -d mcflirt,bet,melodic,diags,mprage --spm basedir subjectID

Process data only without download
 setup_subject_3 -d mcflirt,bet,melodic,diags basedir subjectID
 setup_subject_3 -d mcflirt,bet,melodic,diags,mprage basedir subjectID
 setup_subject_3 -d mprage basedir subjectID

Skip mcflirt,bet,melodic,diags
  setup_subject_3 -s mcflirt,bet,melodic,diags basedir subjectID

====BIDs mode====

======Data Structure======

 basedir/
            |_
                sub-[subjectID]/
                    |_
                        ses-[SESSIONID]/
                               |_
                                    anat/  dwi/  fmap/  func/
             |_
                 sourcedata/
                      |_
                          sub-[subjectID]/
                                 |_
                                     ses-[SESSIONID]/
                                            |_ 
                                                dicom/ setup_log.xxxxxxx
             |_
                 derivatives/
                      |_  
                          sub-[subjectID]/
                                 |_
                                     ses-[SESSIONID]/
                                            |_ 
                                                anat/  dwi/  fmap/  func/

======Commands======

Download data and run debabel with Bids format, skip mprage.

 setup_subject_3 --download ccn,userid,/dicom/data/YOURGROUP/ --bids --config ~/bidsname-sub123.conf -s mprage basedir subjectID

===Notes===
Log File: provides useful details about what commands were run, their output and the script's status. It's located at

 basedir/subjectID/notes/setup_log.date_numbers