sift:command_line
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| sift:command_line [2025/09/11 17:59] – sgranger | sift:command_line [2025/09/23 18:33] (current) – [-RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics] wikisysop | ||
|---|---|---|---|
| Line 42: | Line 42: | ||
| ==== -LoadLib / -l ==== | ==== -LoadLib / -l ==== | ||
| ---- | ---- | ||
| - | Search the provided directory and all sub directories for .cmz files and load them | + | Search the provided directory and all sub directories for .cmz files and load them into the library |
| === Parameters === | === Parameters === | ||
| - | == __directory | + | __**directory |
| A path to the root directory to be searched recursively for .cmzs | A path to the root directory to be searched recursively for .cmzs | ||
| - | * **Data Type:** Directory | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __libQuery__ == | + | __**libQuery **__ \\ |
| - | A query to refine the files loaded into the library. | + | The query used to refine the files loaded into the library |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | == __libSubjTags__ == | + | __**libSubjTags **__ \\ |
| - | A list of subject tags. | + | A list of subject tags that must be included within the .cmzs |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | + | < | |
| ---- | ---- | ||
| Line 64: | Line 63: | ||
| Load and calculate a predifined query | Load and calculate a predifined query | ||
| === Parameters === | === Parameters === | ||
| - | == __file | + | __**file |
| Path to the .q3d containing query definitions | Path to the .q3d containing query definitions | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| + | < | ||
| + | ---- | ||
| + | ==== -SaveProject / -sv ==== | ||
| + | ---- | ||
| + | Save the current project | ||
| + | === Parameters === | ||
| + | __**file (DEFAULT) (REQUIRED) **__ \\ | ||
| + | The path and name of the file | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | < | ||
| + | ---- | ||
| + | ==== -LoadProject / -ld ==== | ||
| + | ---- | ||
| + | Load a previously saved project | ||
| + | === Parameters === | ||
| + | __**file (DEFAULT) (REQUIRED) **__ \\ | ||
| + | The path and name of project to be loaded | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**loadLib **__ \\ | ||
| + | If passed the library associated with the file will be loaded | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -ClearProject / -clr ==== | ||
| + | ---- | ||
| + | Clear and create a new project workspace (All unsaved progress will be lost) | ||
| + | < | ||
| ---- | ---- | ||
| ==== -RunPCA / -pca ==== | ==== -RunPCA / -pca ==== | ||
| ---- | ---- | ||
| - | Run Principal Compnent Analysis | + | Run Principal Compnent Analysis |
| === Parameters === | === Parameters === | ||
| - | == __name | + | __**name |
| - | The name of the new PCA being computed | + | The name of the PCA |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __numPCs__ == | + | __**numPCs **__ \\ |
| - | The number of dimensions to reduce to | + | The number of principal components calculated |
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 4 | * **Default Value:** 4 | ||
| - | == __workspaceMean__ == | + | __**workspaceMean **__ \\ |
| - | If passed | + | If passed run PCA on workspace |
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -RunLOF / -lof ==== | ==== -RunLOF / -lof ==== | ||
| ---- | ---- | ||
| - | Run Local Outlier Factor | + | Run Local Outlier Factor |
| === Parameters === | === Parameters === | ||
| - | == __autoExclude__ == | + | __**autoExclude **__ \\ |
| If passed any outliers found will be excluded automatically | If passed any outliers found will be excluded automatically | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __grouping__ == | + | __**grouping **__ \\ |
| - | How should data be grouped before | + | How should data be grouped before |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** combined group | * **Default Value:** combined group | ||
| - | | + | * **Options:** combined group, group, workspace |
| - | == __manualThreshold__ == | + | __**manualThreshold **__ \\ |
| The threshold to consider when searching for outliers | The threshold to consider when searching for outliers | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 3 | * **Default Value:** 3 | ||
| - | == __numNeighbors__ == | + | __**numNeighbors **__ \\ |
| How many neighbors should each point be compared to | How many neighbors should each point be compared to | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 14 | * **Default Value:** 14 | ||
| - | == __numPasses__ == | + | __**numPasses **__ \\ |
| How many iterations of the test should be run | How many iterations of the test should be run | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1 | * **Default Value:** 1 | ||
| - | == __numPCs__ == | + | __**numPCs **__ \\ |
| How many principal components should the test be run on | How many principal components should the test be run on | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 2 | * **Default Value:** 2 | ||
| - | == __PCsVariance__ == | + | __**PCsVariance **__ \\ |
| Determine the numbe of PCs by variance explained | Determine the numbe of PCs by variance explained | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 95 | * **Default Value:** 95 | ||
| - | == __scaleToVariability__ == | + | __**scaleToVariability **__ \\ |
| Scale all calculated values to the variavility explained by the PC | Scale all calculated values to the variavility explained by the PC | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -RunKMeans / -kmeans ==== | ==== -RunKMeans / -kmeans ==== | ||
| ---- | ---- | ||
| - | Run K-Means | + | Run K-Means |
| === Parameters === | === Parameters === | ||
| - | == __clusters__ == | + | __**clusters **__ \\ |
| - | How many clusters | + | How many clusters |
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 2 | * **Default Value:** 2 | ||
| - | == __customSeed__ == | + | __**customSeed **__ \\ |
| Provide a seed for the random first centroid (produces repeatable results) | Provide a seed for the random first centroid (produces repeatable results) | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 0 | * **Default Value:** 0 | ||
| - | == __grouping__ == | + | __**grouping **__ \\ |
| - | How should data be grouped before | + | How should data be grouped before |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** combined group | * **Default Value:** combined group | ||
| - | | + | * **Options:** combined group, group, workspace |
| - | == __iterations__ == | + | __**iterations **__ \\ |
| How many iterations of the test should be run | How many iterations of the test should be run | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1 | * **Default Value:** 1 | ||
| - | == __numPCs__ == | + | __**numPCs **__ \\ |
| The number of principal components to run the test on | The number of principal components to run the test on | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 2 | * **Default Value:** 2 | ||
| - | == __PCsVariance__ == | + | __**PCsVariance **__ \\ |
| Determine the number of PCs by variance explained | Determine the number of PCs by variance explained | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 95 | * **Default Value:** 95 | ||
| - | == __scaleToVariability__ == | + | __**scaleToVariability **__ \\ |
| - | Scale all calculated values to the variavility | + | Scale all calculated values to the variability |
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -RunSPE / -spe ==== | ==== -RunSPE / -spe ==== | ||
| ---- | ---- | ||
| - | Run Squared Prediction Error | + | Run Squared Prediction Error on the currently active PCA |
| === Parameters === | === Parameters === | ||
| - | == __alphaValue__ == | + | __**alphaValue **__ \\ |
| - | The alpha threshold used to determine outliers: 0.1, 0.05, 0.025, 0.01, 0.005 | + | The alpha threshold used to determine outliers |
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 0.1 | * **Default Value:** 0.1 | ||
| - | | + | * **Options:** 0.1, 0.05, 0.025, 0.01, 0.005 |
| - | == __autoExclude__ == | + | __**autoExclude **__ \\ |
| If passed any outliers found will be exclude automatically | If passed any outliers found will be exclude automatically | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __numPCs__ == | + | __**numPCs **__ \\ |
| The number of principal components to run the test on | The number of principal components to run the test on | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 2 | * **Default Value:** 2 | ||
| - | == __PCsVariance__ == | + | __**PCsVariance **__ \\ |
| scale calculated values to variability explained | scale calculated values to variability explained | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 95 | * **Default Value:** 95 | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -RunMah / -mah ==== | ==== -RunMah / -mah ==== | ||
| ---- | ---- | ||
| - | Run Mahalanobis Distance test | + | Run Mahalanobis Distance test on the currently active PCA |
| === Parameters === | === Parameters === | ||
| - | == __alphaValue__ == | + | __**alphaValue **__ \\ |
| - | The alpha threshold used to determine outliers: 0.1, 0.05, 0.025, 0.01, 0.005 | + | The alpha threshold used to determine outliers |
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 0.1 | * **Default Value:** 0.1 | ||
| - | | + | * **Options:** 0.1, 0.05, 0.025, 0.01, 0.005 |
| - | == __autoExclude__ == | + | __**autoExclude **__ \\ |
| If passed any outliers found will be excluded automatically | If passed any outliers found will be excluded automatically | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __grouping__ == | + | __**grouping **__ \\ |
| - | How should data be grouped before running: Combined Groups: All data points will be compared Groups: Data will be compared within groups Workspace: Data will be compared within workspaces | + | How should data be grouped before running |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** combined group | * **Default Value:** combined group | ||
| - | | + | * **Options:** combined group, group, workspace |
| - | == __numPasses__ == | + | __**numPasses **__ \\ |
| How many iterations of the test should be run | How many iterations of the test should be run | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1 | * **Default Value:** 1 | ||
| - | == __numPCs__ == | + | __**numPCs **__ \\ |
| The number of principal components to run the test on | The number of principal components to run the test on | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 2 | * **Default Value:** 2 | ||
| - | == __PCsVariance__ == | + | __**PCsVariance **__ \\ |
| Determing the number of PCs by variance explained instead of number | Determing the number of PCs by variance explained instead of number | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 95 | * **Default Value:** 95 | ||
| - | == __scaleToVariance__ == | + | __**scaleToVariance **__ \\ |
| scale calculated values to variability explained | scale calculated values to variability explained | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -RunV3D / -s / -plpath ==== | ==== -RunV3D / -s / -plpath ==== | ||
| ---- | ---- | ||
| - | Run pipelines via the V3D engine | + | Run pipelines via the Visual3D |
| === Parameters === | === Parameters === | ||
| - | == __exportLog__ == | + | __**exportLog **__ \\ |
| - | If passed | + | If passed |
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | == __onLib__ == | + | __**onLib **__ \\ |
| - | If passed the the loaded library | + | If passed the scripts |
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __script | + | __**script |
| - | A path to the script file to be run, multiple scripts can be passed by repeating the parameter | + | A path to the script file, multiple scripts can be passed by repeating the parameter |
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | + | < | |
| ---- | ---- | ||
| Line 257: | Line 281: | ||
| Run a single V3D pipeline command (Can be used multiple times to execute multiple commands | Run a single V3D pipeline command (Can be used multiple times to execute multiple commands | ||
| === Parameters === | === Parameters === | ||
| - | == __command | + | __**command |
| - | The pipeline command | + | The pipeline command executed |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | + | < | |
| ---- | ---- | ||
| - | ==== -dirpath | + | ==== -DirPath |
| ---- | ---- | ||
| - | Set a global variable to the passed path | + | Set a global variable |
| === Parameters === | === Parameters === | ||
| - | == __path | + | __**path |
| The path to set | The path to set | ||
| - | * **Data Type:** Directory | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| + | < | ||
| + | ---- | ||
| + | ==== -SetEnginePluginsFolder / -SEPF ==== | ||
| + | ---- | ||
| + | Set the location the engine will look for plugins e.g Meta-Commands | ||
| + | === Parameters === | ||
| + | __**folderPath (DEFAULT) (REQUIRED) **__ \\ | ||
| + | The path to the engine plugins folder | ||
| + | * **Data Type:** String (Directory) | ||
| + | * **Default Value:** N/A | ||
| + | < | ||
| ---- | ---- | ||
| ==== -RegisterCurves / -rc ==== | ==== -RegisterCurves / -rc ==== | ||
| ---- | ---- | ||
| - | Register | + | Register |
| === Parameters === | === Parameters === | ||
| - | == __eventSequence__ == | + | __**eventSequence **__ \\ |
| Register by events | Register by events | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __localMax__ == | + | __**localMax **__ \\ |
| - | Use local maximum | + | Register by local maximum |
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __localMaxLower__ == | + | __**localMaxLower **__ \\ |
| The lower bounds of the local max | The lower bounds of the local max | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** -1 | * **Default Value:** -1 | ||
| - | == __localMaxUpper__ == | + | __**localMaxUpper **__ \\ |
| The upper bounds of the local max | The upper bounds of the local max | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** -1 | * **Default Value:** -1 | ||
| - | == __localMin__ == | + | __**localMin **__ \\ |
| - | use local minimum | + | Register by local minimum |
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __localMinLower__ == | + | __**localMinLower **__ \\ |
| The lower bounds of the local minimum | The lower bounds of the local minimum | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** -1 | * **Default Value:** -1 | ||
| - | == __localMinUpper__ == | + | __**localMinUpper **__ \\ |
| The upper bounds of the local minimum | The upper bounds of the local minimum | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** -1 | * **Default Value:** -1 | ||
| - | == __max__ == | + | __**max **__ \\ |
| Register by maximum | Register by maximum | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __min__ == | + | __**min **__ \\ |
| Register by minimum | Register by minimum | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __name | + | __**name |
| - | The name for the group after curve registration | + | The name for the new group created |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -CreateGLM / -glm ==== | ==== -CreateGLM / -glm ==== | ||
| ---- | ---- | ||
| - | Create a General Linear Model | + | Create a General Linear Model using the selected groups / workspaces |
| === Parameters === | === Parameters === | ||
| - | == __grouping__ == | + | __**grouping **__ \\ |
| - | The grouping used for the model : Workspace / Group | + | The grouping used for the model |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** group | * **Default Value:** group | ||
| - | | + | * **Options:** workspace, group |
| - | == __name | + | __**name |
| - | The name of the GLM being created | + | The name of the GLM |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __test__ == | + | __**test **__ \\ |
| - | The intended test type for the model : One sample t-test, Two sample t-test, Paired t-test | + | The intended test type for the model |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** two_sample | * **Default Value:** two_sample | ||
| - | | + | * **Options:** one_sample, two_sample, paired, one_way_anova |
| - | == __workspaceMeans__ == | + | __**workspaceMeans **__ \\ |
| - | If using workspace means, instead of the individual traces | + | If passed use workspace means, instead of the individual traces |
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| Line 355: | Line 386: | ||
| Run Statistical Parameteric Mapping One-Sample T-Test | Run Statistical Parameteric Mapping One-Sample T-Test | ||
| === Parameters === | === Parameters === | ||
| - | == __alpha | + | __**alpha |
| The alpha value to threshold with | The alpha value to threshold with | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __glm (REQUIRED)__ | + | __**glm |
| The name of the GLM to use when creating the SPM | The name of the GLM to use when creating the SPM | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __group | + | __**group |
| The name of the group to test | The name of the group to test | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __name | + | __**name |
| The name of the SPM being created | The name of the SPM being created | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __twoTailed__ == | + | __**twoTailed **__ \\ |
| If two-tailed inference (as opposed to one-tailed) | If two-tailed inference (as opposed to one-tailed) | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| Line 383: | Line 413: | ||
| Run Statistical Parameteric Mapping Two-Sample T-Test | Run Statistical Parameteric Mapping Two-Sample T-Test | ||
| === Parameters === | === Parameters === | ||
| - | == __alpha | + | __**alpha |
| The alpha value to threshold with | The alpha value to threshold with | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __glm (REQUIRED)__ | + | __**glm |
| The name of the GLM to use when creating the SPM | The name of the GLM to use when creating the SPM | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __group1 | + | __**group1 |
| The name of the first group to test | The name of the first group to test | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __group2 | + | __**group2 |
| The name of the second group to test | The name of the second group to test | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __name | + | __**name |
| The name of the SPM being created | The name of the SPM being created | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __twoTailed__ == | + | __**twoTailed **__ \\ |
| If two-tailed inference (as opposed to one-tailed) | If two-tailed inference (as opposed to one-tailed) | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| Line 415: | Line 444: | ||
| Run Statistical Parameteric Mapping Paired T-Test | Run Statistical Parameteric Mapping Paired T-Test | ||
| === Parameters === | === Parameters === | ||
| - | == __alpha | + | __**alpha |
| The alpha value to threshold with | The alpha value to threshold with | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __glm (REQUIRED)__ | + | __**glm |
| The name of the GLM to use when creating the SPM | The name of the GLM to use when creating the SPM | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __group1 | + | __**group1 |
| The name of the first group to test | The name of the first group to test | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __group2 | + | __**group2 |
| The name of the second group to test | The name of the second group to test | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __name | + | __**name |
| The name of the SPM being created | The name of the SPM being created | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __twoTailed__ == | + | __**twoTailed **__ \\ |
| If two-tailed inference (as opposed to one-tailed) | If two-tailed inference (as opposed to one-tailed) | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -RunSPMOneWayAnova ==== | ==== -RunSPMOneWayAnova ==== | ||
| ---- | ---- | ||
| - | Run Statistical Parameteric Mapping | + | Run Statistical Parameteric Mapping |
| === Parameters === | === Parameters === | ||
| - | == __alpha | + | __**alpha |
| The alpha value to threshold with | The alpha value to threshold with | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __glm (REQUIRED)__ | + | __**glm |
| The name of the GLM to use when creating the SPM | The name of the GLM to use when creating the SPM | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __name | + | __**name |
| The name of the SPM being created | The name of the SPM being created | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __twoTailed__ == | + | __**twoTailed **__ \\ |
| If two-tailed inference (as opposed to one-tailed) | If two-tailed inference (as opposed to one-tailed) | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| Line 471: | Line 498: | ||
| Run Dynamic Time Warping | Run Dynamic Time Warping | ||
| === Parameters === | === Parameters === | ||
| - | == __name | + | __**name |
| The name of the DTW test being run | The name of the DTW test being run | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __standardDeviations__ == | + | __**standardDeviations **__ \\ |
| How many standard deviation to test for: 1-3 | How many standard deviation to test for: 1-3 | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1 | * **Default Value:** 1 | ||
| - | | + | * **Options:** 1, 2, 3 |
| - | + | < | |
| ---- | ---- | ||
| Line 488: | Line 514: | ||
| Export queried data | Export queried data | ||
| === Parameters === | === Parameters === | ||
| - | == __allSequencesNorm__ == | + | __**allSequencesNorm **__ \\ |
| CommandExport all sequences normalized | CommandExport all sequences normalized | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __allSequencesTime__ == | + | __**allSequencesTime **__ \\ |
| CommandExport all time based sequences | CommandExport all time based sequences | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __eventsNorm__ == | + | __**eventsNorm **__ \\ |
| CommandExport all events normalized | CommandExport all events normalized | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __eventsOrig__ == | + | __**eventsOrig **__ \\ |
| CommandExport all time based events | CommandExport all time based events | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __exportFormat__ == | + | __**exportFormat **__ \\ |
| What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** standard | * **Default Value:** standard | ||
| - | | + | * **Options:** standard, transposed, spss, p2d |
| - | == __file | + | __**file |
| Desired path for the text export to be saved | Desired path for the text export to be saved | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __groupMean__ == | + | __**groupMean **__ \\ |
| CommandExport the mean value of each group | CommandExport the mean value of each group | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __groupStdDev__ == | + | __**groupStdDev **__ \\ |
| CommandExport the standard deviation of each group | CommandExport the standard deviation of each group | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __normalizedTo__ == | + | __**normalizedTo **__ \\ |
| Normalize values to... | Normalize values to... | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** 101 | * **Default Value:** 101 | ||
| - | == __precision__ == | + | __**precision **__ \\ |
| How many decimal places should values be displayed to | How many decimal places should values be displayed to | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** 4 | * **Default Value:** 4 | ||
| - | == __workspaceMean__ == | + | __**workspaceMean **__ \\ |
| CommandExport the mean of each workspace | CommandExport the mean of each workspace | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __workspaceStdDev__ == | + | __**workspaceStdDev **__ \\ |
| CommandExport the standard deviation of each workspace | CommandExport the standard deviation of each workspace | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| Line 545: | Line 570: | ||
| Export summary statistics | Export summary statistics | ||
| === Parameters === | === Parameters === | ||
| - | == __addMetrics__ == | + | __**addMetrics **__ \\ |
| Export metrics | Export metrics | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __exportFormat__ == | + | __**exportFormat **__ \\ |
| What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** standard | * **Default Value:** standard | ||
| - | | + | * **Options:** standard, transposed, spss, p2d |
| - | == __file | + | __**file |
| Desired path for the text export to be saved | Desired path for the text export to be saved | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __max__ == | + | __**max **__ \\ |
| Export the maximum value | Export the maximum value | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __maxEventPoint__ == | + | __**maxEventPoint **__ \\ |
| Export the maximum event point | Export the maximum event point | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __maxStdDev__ == | + | __**maxStdDev **__ \\ |
| Export the maximum standard deviation | Export the maximum standard deviation | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __mean__ == | + | __**mean **__ \\ |
| Export the mean value | Export the mean value | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __meanStdDev__ == | + | __**meanStdDev **__ \\ |
| Export the mean standard deviation | Export the mean standard deviation | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __min__ == | + | __**min **__ \\ |
| Export the minimum value | Export the minimum value | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __minEventPoint__ == | + | __**minEventPoint **__ \\ |
| Export the minimum event point | Export the minimum event point | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __minStdDev__ == | + | __**minStdDev **__ \\ |
| Export the minimum standard deviation | Export the minimum standard deviation | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __normalizeMetrics__ == | + | __**normalizeMetrics **__ \\ |
| Normalize exported metrics | Normalize exported metrics | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __precision__ == | + | __**precision **__ \\ |
| How many decimal places should values be displayed to | How many decimal places should values be displayed to | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** 4 | * **Default Value:** 4 | ||
| - | == __results__ == | + | __**results **__ \\ |
| Export results for: Groups, Workspaces, Instances | Export results for: Groups, Workspaces, Instances | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** groups | * **Default Value:** groups | ||
| - | | + | * **Options:** groups, workspaces, instances |
| - | + | < | |
| ---- | ---- | ||
| Line 611: | Line 635: | ||
| Export results of curve registration | Export results of curve registration | ||
| === Parameters === | === Parameters === | ||
| - | == __exportFormat__ == | + | __**exportFormat **__ \\ |
| What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** standard | * **Default Value:** standard | ||
| - | | + | * **Options:** standard, transposed, spss, p2d |
| - | == __file | + | __**file |
| Desired path for the text export to be saved | Desired path for the text export to be saved | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __landmarkAll__ == | + | __**landmarkAll **__ \\ |
| Export all landmarks | Export all landmarks | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __landmarkMeans__ == | + | __**landmarkMeans **__ \\ |
| Export the landmark mean value | Export the landmark mean value | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __precision__ == | + | __**precision **__ \\ |
| How many decimal places should values be displayed to | How many decimal places should values be displayed to | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** 4 | * **Default Value:** 4 | ||
| - | == __registeredCurves__ == | + | __**registeredCurves **__ \\ |
| Export registered curves | Export registered curves | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __warpingFunctions__ == | + | __**warpingFunctions **__ \\ |
| Export all warping functions | Export all warping functions | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| Line 648: | Line 671: | ||
| Export Dynamic Time Warping results | Export Dynamic Time Warping results | ||
| === Parameters === | === Parameters === | ||
| - | == __costFunctions__ == | + | __**costFunctions **__ \\ |
| Export cost functions | Export cost functions | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __exportFormat__ == | + | __**exportFormat **__ \\ |
| What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** standard | * **Default Value:** standard | ||
| - | | + | * **Options:** standard, transposed, spss, p2d |
| - | == __file | + | __**file |
| Desired path for the text export to be saved | Desired path for the text export to be saved | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __foundAnomalies__ == | + | __**foundAnomalies **__ \\ |
| Export all outliers found with dynamic time warping | Export all outliers found with dynamic time warping | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __precision__ == | + | __**precision **__ \\ |
| How many decimal places should values be displayed to | How many decimal places should values be displayed to | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** 4 | * **Default Value:** 4 | ||
| - | + | < | |
| ---- | ---- | ||
| Line 677: | Line 699: | ||
| Export Statistical Parameteric Mapping results | Export Statistical Parameteric Mapping results | ||
| === Parameters === | === Parameters === | ||
| - | == __bMatrix__ == | + | __**bMatrix **__ \\ |
| Export the B Matrix used | Export the B Matrix used | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __exportFormat__ == | + | __**exportFormat **__ \\ |
| What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** standard | * **Default Value:** standard | ||
| - | | + | * **Options:** standard, transposed, spss, p2d |
| - | == __file | + | __**file |
| Desired path for the text export to be saved | Desired path for the text export to be saved | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __precision__ == | + | __**precision **__ \\ |
| How many decimal places should values be displayed to | How many decimal places should values be displayed to | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** 4 | * **Default Value:** 4 | ||
| - | == __residualMatrix__ == | + | __**residualMatrix **__ \\ |
| Export the residual matrix | Export the residual matrix | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __spm__ == | + | __**spm **__ \\ |
| Export the statistical parameteric map | Export the statistical parameteric map | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| Line 710: | Line 731: | ||
| Export Principal Component Analysis results | Export Principal Component Analysis results | ||
| === Parameters === | === Parameters === | ||
| - | == __eigenVectors__ == | + | __**eigenVectors **__ \\ |
| Export the eigen vectors | Export the eigen vectors | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __exportFormat__ == | + | __**exportFormat **__ \\ |
| What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** standard | * **Default Value:** standard | ||
| - | | + | * **Options:** standard, transposed, spss, p2d |
| - | == __file | + | __**file |
| Desired path for the text export to be saved | Desired path for the text export to be saved | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __groupScores__ == | + | __**groupScores **__ \\ |
| Export group scores | Export group scores | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __groupStdDev__ == | + | __**groupStdDev **__ \\ |
| Export group standard deviation | Export group standard deviation | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __kMeans__ == | + | __**kMeans **__ \\ |
| Export K-Means results | Export K-Means results | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __lof__ == | + | __**lof **__ \\ |
| Export local outlier factor results | Export local outlier factor results | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __lofThreshold__ == | + | __**lofThreshold **__ \\ |
| Export threshould to determine an LOF outlier | Export threshould to determine an LOF outlier | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __mahDis__ == | + | __**mahDis **__ \\ |
| Export the mahalanobis distance results | Export the mahalanobis distance results | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __mahDisThreshold__ == | + | __**mahDisThreshold **__ \\ |
| Export the threshold used to determine a mahalanobis distance outlier | Export the threshold used to determine a mahalanobis distance outlier | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __mean595__ == | + | __**mean595 **__ \\ |
| Export the mean plus or minus 5 and 95% | Export the mean plus or minus 5 and 95% | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __meanSD__ == | + | __**meanSD **__ \\ |
| Export the mean plus or minus one standard deviation | Export the mean plus or minus one standard deviation | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __precision__ == | + | __**precision **__ \\ |
| How many decimal places should values be displayed to | How many decimal places should values be displayed to | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** 4 | * **Default Value:** 4 | ||
| - | == __spe__ == | + | __**spe **__ \\ |
| Export squared prediction error results | Export squared prediction error results | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __speThreshold__ == | + | __**speThreshold **__ \\ |
| Export the threshold to determine an SPE outlier | Export the threshold to determine an SPE outlier | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __varianceExplained__ == | + | __**varianceExplained **__ \\ |
| Export the variance explained | Export the variance explained | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __workspaceScores__ == | + | __**workspaceScores **__ \\ |
| Export workspace scores | Export workspace scores | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ==== | ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ==== | ||
| ---- | ---- | ||
| + | Export a signal time plot using the currently selected groups / workspaces | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __groupDispersion__ == | + | __**groupDispersion **__ \\ |
| If passed group dispersion will be plotted | If passed group dispersion will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __groupDispersionType__ == | + | __**groupDispersionType **__ \\ |
| The type of dispersion to be displayed for groups | The type of dispersion to be displayed for groups | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** One Standard Deviation | * **Default Value:** One Standard Deviation | ||
| - | | + | * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range |
| - | == __groupMean__ == | + | __**groupMean **__ \\ |
| If passed group mean will be plotted | If passed group mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __rawTraces__ == | + | __**rawTraces **__ \\ |
| If passed indivdual traces will be plotted | If passed indivdual traces will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __workspaceDispersion__ == | + | __**workspaceDispersion **__ \\ |
| If passed workspace dispersion will be plotted | If passed workspace dispersion will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __workspaceDispersionType__ == | + | __**workspaceDispersionType **__ \\ |
| The type of dispersion to be displayed for workspaces | The type of dispersion to be displayed for workspaces | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** One Standard Deviation | * **Default Value:** One Standard Deviation | ||
| - | | + | * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range |
| - | == __workspaceMean__ == | + | __**workspaceMean **__ \\ |
| If passed workspace mean will be plotted | If passed workspace mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotMetric / -ExportPlotM / -EPM ==== | ==== -ExportPlotMetric / -ExportPlotM / -EPM ==== | ||
| ---- | ---- | ||
| + | Export a metric plot using the currently selected groups / workspaces | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __groupDispersion__ == | + | __**groupDispersion **__ \\ |
| If passed group dispersion will be plotted | If passed group dispersion will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __groupDispersionType__ == | + | __**groupDispersionType **__ \\ |
| The type of dispersion to be displayed for groups | The type of dispersion to be displayed for groups | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** One Standard Deviation | * **Default Value:** One Standard Deviation | ||
| - | | + | * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range |
| - | == __groupMean__ == | + | __**groupMean **__ \\ |
| If passed group mean will be plotted | If passed group mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __meanPlotStyle__ == | + | __**meanPlotStyle **__ \\ |
| How should means be displayed | How should means be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Bar Chart | * **Default Value:** Bar Chart | ||
| - | | + | * **Options:** Bar Chart, Stacked Bar Chart, Box Plot |
| - | == __metricGrouping__ == | + | __**metricGrouping **__ \\ |
| How should workspace means be grouped? | How should workspace means be grouped? | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** No Group | * **Default Value:** No Group | ||
| - | | + | * **Options:** No Group, Group, Workspace |
| - | == __rawTraces__ == | + | __**rawTraces **__ \\ |
| If passed indivdual traces will be plotted | If passed indivdual traces will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __workspaceDispersion__ == | + | __**workspaceDispersion **__ \\ |
| If passed workspace dispersion will be plotted | If passed workspace dispersion will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __workspaceDispersionType__ == | + | __**workspaceDispersionType **__ \\ |
| The type of dispersion to be displayed for workspaces | The type of dispersion to be displayed for workspaces | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** One Standard Deviation | * **Default Value:** One Standard Deviation | ||
| - | | + | * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range |
| - | == __workspaceMean__ == | + | __**workspaceMean **__ \\ |
| If passed workspace mean will be plotted | If passed workspace mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ==== | ==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ==== | ||
| ---- | ---- | ||
| + | Export a Signal Signal plot using the currently selected groups / workspaces | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __groupDispersion__ == | + | __**groupDispersion **__ \\ |
| If passed group dispersion will be plotted | If passed group dispersion will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __groupDispersionType__ == | + | __**groupDispersionType **__ \\ |
| The type of dispersion to be displayed for groups | The type of dispersion to be displayed for groups | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** One Standard Deviation | * **Default Value:** One Standard Deviation | ||
| - | | + | * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range |
| - | == __groupMean__ == | + | __**groupMean **__ \\ |
| If passed group mean will be plotted | If passed group mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __pair | + | __**pair |
| Add a pair of two groups, seperare group names with ' | Add a pair of two groups, seperare group names with ' | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __rawTraces__ == | + | __**rawTraces **__ \\ |
| If passed indivdual traces will be plotted | If passed indivdual traces will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __workspaceDispersion__ == | + | __**workspaceDispersion **__ \\ |
| If passed workspace dispersion will be plotted | If passed workspace dispersion will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __workspaceDispersionType__ == | + | __**workspaceDispersionType **__ \\ |
| The type of dispersion to be displayed for workspaces | The type of dispersion to be displayed for workspaces | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** One Standard Deviation | * **Default Value:** One Standard Deviation | ||
| - | | + | * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range |
| - | == __workspaceMean__ == | + | __**workspaceMean **__ \\ |
| If passed workspace mean will be plotted | If passed workspace mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ==== | ==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ==== | ||
| ---- | ---- | ||
| + | Export a Metric Metric plot using the currently selected groups / workspaces | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __groupDispersion__ == | + | __**groupDispersion **__ \\ |
| If passed group dispersion will be plotted | If passed group dispersion will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __groupDispersionType__ == | + | __**groupDispersionType **__ \\ |
| The type of dispersion to be displayed for groups | The type of dispersion to be displayed for groups | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** One Standard Deviation | * **Default Value:** One Standard Deviation | ||
| - | | + | * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range |
| - | == __groupMean__ == | + | __**groupMean **__ \\ |
| If passed group mean will be plotted | If passed group mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __jitterX__ == | + | __**jitterX **__ \\ |
| The random offset of each point on the X Axis | The random offset of each point on the X Axis | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 0 | * **Default Value:** 0 | ||
| - | == __jitterY__ == | + | __**jitterY **__ \\ |
| The random offset of each pointer on the Y Axis | The random offset of each pointer on the Y Axis | ||
| * **Data Type:** Decimal | * **Data Type:** Decimal | ||
| * **Default Value:** 0 | * **Default Value:** 0 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __pair | + | __**pair |
| Add a pair of two groups, seperare group names with ' | Add a pair of two groups, seperare group names with ' | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __rawTraces__ == | + | __**rawTraces **__ \\ |
| If passed indivdual traces will be plotted | If passed indivdual traces will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __workspaceDispersion__ == | + | __**workspaceDispersion **__ \\ |
| If passed workspace dispersion will be plotted | If passed workspace dispersion will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __workspaceDispersionType__ == | + | __**workspaceDispersionType **__ \\ |
| The type of dispersion to be displayed for workspaces | The type of dispersion to be displayed for workspaces | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** One Standard Deviation | * **Default Value:** One Standard Deviation | ||
| - | | + | * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range |
| - | == __workspaceMean__ == | + | __**workspaceMean **__ \\ |
| If passed workspace mean will be plotted | If passed workspace mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotSPM / -EPSPM ==== | ==== -ExportPlotSPM / -EPSPM ==== | ||
| ---- | ---- | ||
| + | Export the current SPM plot | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotResiduals / -ExportPlotR / -EPR ==== | ==== -ExportPlotResiduals / -ExportPlotR / -EPR ==== | ||
| ---- | ---- | ||
| + | Export the current GLMs residuals plot | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| Line 1233: | Line 1247: | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ==== | ==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ==== | ||
| ---- | ---- | ||
| + | Export the current PCAs variance explained plot | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ==== | ==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ==== | ||
| ---- | ---- | ||
| + | Export the current PCAs loading vectors plot | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __flipPC__ == | + | __**flipPC **__ \\ |
| If passed, invert PC | If passed, invert PC | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __pcNumber__ == | + | __**pcNumber **__ \\ |
| The principal component to plot. | The principal component to plot. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1 | * **Default Value:** 1 | ||
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS ==== | ==== -ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS ==== | ||
| ---- | ---- | ||
| + | Export the current PCAs workspace scores plot | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __normalizeScores__ == | + | __**normalizeScores **__ \\ |
| If passed workspace scores will be normalized | If passed workspace scores will be normalized | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __XAxisPC__ == | + | __**XAxisPC **__ \\ |
| Principal Component represented on the X Axis | Principal Component represented on the X Axis | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1 | * **Default Value:** 1 | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YAxisPC__ == | + | __**YAxisPC **__ \\ |
| Prinicipal Component represented on the Y Axis | Prinicipal Component represented on the Y Axis | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 2 | * **Default Value:** 2 | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotGroupScores / -ExportPlotGS / -EPGS ==== | ==== -ExportPlotGroupScores / -ExportPlotGS / -EPGS ==== | ||
| ---- | ---- | ||
| + | Export the current PCAs groups scores plot | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotReconstruction / -ExportPlotR / -EPR ==== | ==== -ExportPlotReconstruction / -ExportPlotR / -EPR ==== | ||
| ---- | ---- | ||
| + | Export the current PCAs reconstruction plot | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __group__ == | + | __**group **__ \\ |
| What group to reconstruct, | What group to reconstruct, | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | == __groupMean__ == | + | __**groupMean **__ \\ |
| If passed group mean will be plotted | If passed group mean will be plotted | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __pc__ == | + | __**pc **__ \\ |
| What PCs to reconstruct, | What PCs to reconstruct, | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __workspace__ == | + | __**workspace **__ \\ |
| What workspace to reconstruct, | What workspace to reconstruct, | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ExportPlotExtreme / -ExportPlotE / -EPE ==== | ==== -ExportPlotExtreme / -ExportPlotE / -EPE ==== | ||
| ---- | ---- | ||
| + | Export the current PCAs extreme plot | ||
| === Parameters === | === Parameters === | ||
| - | == __dataStyle__ == | + | __**dataStyle **__ \\ |
| The data style to use when generating plot. | The data style to use when generating plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** Workspace | * **Default Value:** Workspace | ||
| - | | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | == __filePath | + | __**filePath |
| The file path the plot will be saved to. | The file path the plot will be saved to. | ||
| - | * **Data Type:** File | + | * **Data Type: |
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __height__ == | + | __**height **__ \\ |
| The height of the image exported. | The height of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __legend__ == | + | __**legend **__ \\ |
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == __pcNumber__ == | + | __**pcNumber **__ \\ |
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1 | * **Default Value:** 1 | ||
| - | == __plotType__ == | + | __**plotType **__ \\ |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** StdDevRecon | * **Default Value:** StdDevRecon | ||
| - | | + | * **Options:** StdDevRecon, |
| - | == __title__ == | + | __**title **__ \\ |
| The title of the plot. | The title of the plot. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __width__ == | + | __**width **__ \\ |
| The width of the image exported. | The width of the image exported. | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 1000 | * **Default Value:** 1000 | ||
| - | == __xLabel__ == | + | __**xLabel **__ \\ |
| Label for the X-Axis. | Label for the X-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __XRange__ == | + | __**XRange **__ \\ |
| - | The display range of the X Axis: "X,Y" | + | The display range of the X Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __yLabel__ == | + | __**yLabel **__ \\ |
| Label for the Y-Axis. | Label for the Y-Axis. | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | == __YRange__ == | + | __**YRange **__ \\ |
| - | The display range of the Y Axis: "X,Y" | + | The display range of the Y Axis: "Max,Min" |
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** ### | * **Default Value:** ### | ||
| - | + | < | |
| ---- | ---- | ||
| Line 1628: | Line 1635: | ||
| Select queried signals (if no parameters are passed all signals are selected) | Select queried signals (if no parameters are passed all signals are selected) | ||
| === Parameters === | === Parameters === | ||
| - | == __group__ == | + | __**group **__ \\ |
| The name of a group to be selected (pass multiple times to select more than one) | The name of a group to be selected (pass multiple times to select more than one) | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | == __workspace__ == | + | __**workspace **__ \\ |
| The name of a workspace to be selcted (pass multiple time to select more than one) | The name of a workspace to be selcted (pass multiple time to select more than one) | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | + | < | |
| ---- | ---- | ||
| Line 1644: | Line 1650: | ||
| Select queried metrics (if no parameters are passed all metrics are selected) | Select queried metrics (if no parameters are passed all metrics are selected) | ||
| === Parameters === | === Parameters === | ||
| - | == __group__ == | + | __**group **__ \\ |
| The name of the group to be selected (pass multiple times to select more than one) | The name of the group to be selected (pass multiple times to select more than one) | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | == __workspace__ == | + | __**workspace **__ \\ |
| The name of the workspace to be selected (pass multiple times to select more than one) | The name of the workspace to be selected (pass multiple times to select more than one) | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | + | < | |
| - | + | ||
| - | + | ||
| - | ---- | + | |
| - | ==== -SaveProject | + | |
| - | ---- | + | |
| - | Save the current project | + | |
| - | === Parameters === | + | |
| - | == __file (DEFAULT) (REQUIRED)__ == | + | |
| - | The path and name of the file | + | |
| - | * **Data Type:** File | + | |
| - | * **Default Value:** N/A | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | ---- | + | |
| - | ==== -LoadProject / -ld ==== | + | |
| - | ---- | + | |
| - | Load a previously saved project | + | |
| - | === Parameters === | + | |
| - | == __file (DEFAULT) (REQUIRED)__ == | + | |
| - | The path and name of project to be loaded | + | |
| - | * **Data Type:** File | + | |
| - | * **Default Value:** N/A | + | |
| - | == __LoadLib__ == | + | |
| - | If passed the library associated with the file will be loaded | + | |
| - | * **Data Type:** True / False | + | |
| - | * **Default Value:** false | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | ---- | + | |
| - | ==== -ClearProject / -clr ==== | + | |
| - | ---- | + | |
| - | Clear and create a new project workspace | + | |
| - | === Parameters === | + | |
| - | + | ||
| ---- | ---- | ||
| ==== -CreateWatcher / -cw ==== | ==== -CreateWatcher / -cw ==== | ||
| ---- | ---- | ||
| - | Creates a directory watcher | + | Creates a new directory watcher |
| === Parameters === | === Parameters === | ||
| - | == __delay__ == | + | __**delay **__ \\ |
| The number of ms to wait before executing scripts after watcher is triggered | The number of ms to wait before executing scripts after watcher is triggered | ||
| * **Data Type:** Integer | * **Data Type:** Integer | ||
| * **Default Value:** 3000 | * **Default Value:** 3000 | ||
| - | == __directory | + | __**directory |
| The directories to be watched, pass multiple times to add more directories | The directories to be watched, pass multiple times to add more directories | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __name | + | __**name |
| The name of the watcher being created | The name of the watcher being created | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __overwrite__ == | + | __**overwrite **__ \\ |
| If passed and existing watchers with the same name will be overwritten | If passed and existing watchers with the same name will be overwritten | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __recursive__ == | + | __**recursive **__ \\ |
| If passed all subdirectories will be watched as well | If passed all subdirectories will be watched as well | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | == __script | + | __**script |
| A list of paths to the scripts to execute when the watcher is triggered | A list of paths to the scripts to execute when the watcher is triggered | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | == __triggerOnDelete__ == | + | __**triggerOnDelete **__ \\ |
| - | If passed watcher will be triggered when a file is deleted | + | If passed watcher will be triggered when a file is deleted |
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| ==== -ActivateWatcher / -aw ==== | ==== -ActivateWatcher / -aw ==== | ||
| ---- | ---- | ||
| - | Activate the passed watcher(s), if no watcher is passed activate all watchers | + | Activate the passed watcher(s) if not already activated |
| === Parameters === | === Parameters === | ||
| - | == __name | + | __**name |
| - | The name of the watcher to be activated | + | The name of the watcher to be activated, pass multiple times to activate multiple watchers. |
| + | if not passed all watcher will be activated. | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | + | < | |
| ---- | ---- | ||
| Line 1744: | Line 1712: | ||
| Deactivate the passed watcher(s), if no watcher is passed deactivate all watchers | Deactivate the passed watcher(s), if no watcher is passed deactivate all watchers | ||
| === Parameters === | === Parameters === | ||
| - | == __name | + | __**name |
| The name of the watcher to be deactivated | The name of the watcher to be deactivated | ||
| * **Data Type:** List | * **Data Type:** List | ||
| * **Default Value:** NULL | * **Default Value:** NULL | ||
| - | + | < | |
| ---- | ---- | ||
| Line 1756: | Line 1723: | ||
| Deletes the passed watcher if it exists | Deletes the passed watcher if it exists | ||
| === Parameters === | === Parameters === | ||
| - | == __name | + | __**name |
| The name of the watcher to be deleted | The name of the watcher to be deleted | ||
| * **Data Type:** String | * **Data Type:** String | ||
| * **Default Value:** N/A | * **Default Value:** N/A | ||
| - | + | < | |
| ---- | ---- | ||
| Line 1767: | Line 1733: | ||
| ---- | ---- | ||
| List all watchers | List all watchers | ||
| - | === Parameters === | + | < |
| - | + | ||
| ---- | ---- | ||
| Line 1776: | Line 1740: | ||
| Set Sift to lauch minimized to the system tray by default. | Set Sift to lauch minimized to the system tray by default. | ||
| === Parameters === | === Parameters === | ||
| - | == __disable__ == | + | __**disable **__ \\ |
| If passed Sift will will no longer launch minimized to the system tray. | If passed Sift will will no longer launch minimized to the system tray. | ||
| - | * **Data Type:** True / False | + | * **Data Type: |
| * **Default Value:** false | * **Default Value:** false | ||
| - | + | < | |
| ---- | ---- | ||
| Line 1787: | Line 1750: | ||
| ---- | ---- | ||
| Immediatly launch a background instance of Sift in the system tray. | Immediatly launch a background instance of Sift in the system tray. | ||
| - | === Parameters === | + | < |
| - | + | ||
| ---- | ---- | ||
| - | ==== -Exit / -x ==== | + | ==== -RunSummaryMetrics |
| ---- | ---- | ||
| - | Exit Sift | + | Compute Summary Metrics |
| === Parameters === | === Parameters === | ||
| - | + | __**EventIndex **__ \\ | |
| + | Index Event to compute Metrics at. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | __**GlobalMax **__ \\ | ||
| + | Compute Global Max. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**GlobalMin **__ \\ | ||
| + | Compute Global Min. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**Group (REQUIRED) **__ \\ | ||
| + | The group you will calculate metrics for. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**LocalMax **__ \\ | ||
| + | Compute Local Max. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**LocalMaxEnd **__ \\ | ||
| + | Local Max End Range. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 0 | ||
| + | __**LocalMaxStart **__ \\ | ||
| + | Local Max Start Range. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 0 | ||
| + | __**LocalMin **__ \\ | ||
| + | Compute Local Min. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**LocalMinEnd **__ \\ | ||
| + | Local Min End Range. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 0 | ||
| + | __**LocalMinStart **__ \\ | ||
| + | Local Min Start Range. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 0 | ||
| + | __**MaxBetweenEvents **__ \\ | ||
| + | Compute Maximum Between Events. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**MaxEventEndIndex **__ \\ | ||
| + | Index of End Event for Maximum Between Events. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | __**MaxEventStartIndex **__ \\ | ||
| + | Index of Start Event for Maximum Between Events. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | __**Mean **__ \\ | ||
| + | Compute Mean. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**MetricAtEvent **__ \\ | ||
| + | Compute Metric at Event. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**MinBetweenEvents **__ \\ | ||
| + | Compute Minimum Between Events. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**MinEventEndIndex **__ \\ | ||
| + | Index of End Event for Minimum Between Events. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | __**MinEventStartIndex **__ \\ | ||
| + | Index of Start Event for Minimum Between Events. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | __**StandardDeviation **__ \\ | ||
| + | Compute Standard Deviation. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**StandardError **__ \\ | ||
| + | Compute Standard Error. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**UseExcludedData **__ \\ | ||
| + | Use Excluded Data to compute metrics. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**Workspaces **__ \\ | ||
| + | Workspaces you will calculate metrics for. If left blank all workspaces will be used. | ||
| + | * **Data Type:** List | ||
| + | * **Default Value:** NULL | ||
| + | < | ||
| + | -RunSummaryMetrics Group " | ||
| ---- | ---- | ||
| - | ==== -SetEnginePluginsFolder | + | ==== -Exit / -x ==== |
| ---- | ---- | ||
| - | Set the location the engine will look for plugins e.g Meta-Commands | + | Exit Sift |
| - | === Parameters === | + | < |
| - | == __folderPath (DEFAULT) (REQUIRED)__ == | + | |
| - | The path to the engine plugins folder | + | |
| - | * **Data Type:** Directory | + | |
| - | * **Default Value:** N/A | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
sift/command_line.1757613550.txt.gz · Last modified: 2025/09/11 17:59 by sgranger