When an acquisition file is added or modified, all files in the acquisition will be compared to all project-level rules to determine if any new gears should be run on the data in the acquisition. The rule uses logical criteria to determine if a gear should be triggered for an individual file.
Prefer to watch a video?
We have a collection of videos showing you how to get the most out of Flywheel. See these for more directions:
The Project Admin can select from the following criteria to create the rule logic:
|
Logic Criteria |
Notes |
|
File Type |
File Type refers to the specified type in the Flywheel Core. Common file types are: dicom, nifti, bvec, bval, parrec, pfile, and ismrmrd. A given file's type must match for this rule to apply. |
|
File Name |
A given file with the name specified will match this rule. Wildcards are accepted (e.g., myfile*.nii.gz). |
|
File Classification |
File classification must match the specified type for the rule to apply. Learn more about how data gets classified in Flywheel or see the list of default file classifications for MR data in Flywheel. You can also create custom classifications for your data. |
|
Acquisition File Type |
An acquisition must have files that match the specified type for this rule to apply. Common file types are: dicom, nifti, bvec, bval, parrec, pfile, and ismrmrd. This specification is useful for Gears that accept multiple input file types (e.g., bvec, bval, nifti). |
|
Acquisition File Classification |
An acquisition must have files that match the specified classification for this rule to apply. Learn more about how data gets classified in Flywheel or see the list of default file classifications for MR data in Flywheel. You can also create custom classifications for your data. |
Rule criteria can be specified under Any or All. For the gear to trigger, a file must match all criteria under the All category and at least one under the Any category. If either category is left blank, it is ignored. If the Except category is matched then the rule will not run.
If the Regex checkbox is selected, the text string entered will be interpreted with Regular Expression rules, or if it's not selected than an exact match of the string will be used in the criteria.
The example rule below will run the MRIQC gear on all files of type "nifti" and all files of classification matching the regular expression ^(Structural|Functional)$ and all files matching classification matching ^(T1|T2|T2\*)$ when they are added to the system. The exception to this rule is then if the file matches the classification "In-Plane."
Note: Adding or modifying a rule will only run gears on new files/modifications made to acquisitions after the rule changes are saved. It will not trigger jobs for existing data.