w4mcorcov: w4mcorcov.xml comparison

comparison w4mcorcov.xml @ 5:50f60f94c034 draft

planemo upload for repository https://github.com/HegemanLab/w4mcorcov_galaxy_wrapper/tree/master commit aff1790e25523d038a1e9528de748191c096132f

author	eschen42
date	Fri, 30 Mar 2018 14:59:19 -0400
parents	8bba31f628da
children	7bd523ca1f9a

comparison

equal deleted inserted replaced

-:8bba31f628da
+:50f60f94c034
-<tool id="w4mcorcov" name="OPLS-DA_Contrasts" version="0.98.7">
+<tool id="w4mcorcov" name="OPLS-DA_Contrasts" version="0.98.8">
 <description>OPLS-DA Contrasts of Univariate Results</description>
+<macros>
+<xml name="paramPairSigFeatOnly">
+			<param
+				name="pairSigFeatOnly"
+				type="boolean"
+				checked="true"
+				truevalue="TRUE"
+				falsevalue="FALSE"
+				label="Retain only pairwise-significant features"
+				help="When this option is set to 'Yes', analysis will be performed including only features that differ significantly for the pair of levels being contrasted; when set to 'No', any feature that varies significantly across all levels will be included (i.e., exclude any feature that is not significantly different across all levels).  See examples below." />
+</xml>
+	</macros>
 <requirements>
 <requirement type="package">r-batch</requirement>
 <requirement type="package">bioconductor-ropls</requirement>
-<!-- <requirement type="package">r-foreach</requirement> -->
 </requirements>
 <stdio>
 <exit_code range="1:" level="fatal" />
 </stdio>
 <command><![CDATA[
 cd $__tool_directory__; Rscript w4mcorcov_wrapper.R
 dataMatrix_in "$dataMatrix_in"
 sampleMetadata_in "$sampleMetadata_in"
 variableMetadata_in "$variableMetadata_in"
-tesC "$tesC"
 facC "$facC"
-pairSigFeatOnly "$pairSigFeatOnly"
+#if str( $signif_test.tesC ) == "none":
+tesC "none"
+pairSigFeatOnly "FALSE"
+#else:
+tesC "$signif_test.tesC"
+pairSigFeatOnly "$signif_test.pairSigFeatOnly"
+#end if
 levCSV '$levCSV'
 matchingC '$matchingC'
 labelFeatures '$labelFeatures'
-labelOrthoFeatures '$labelOrthoFeatures'
 contrast_detail '$contrast_detail'
 contrast_corcov '$contrast_corcov'
 contrast_salience '$contrast_salience'
 ]]></command>
 <inputs>
 <param name="dataMatrix_in" label="Data matrix file" type="data" format="tabular" help="Features x samples (tabular data - decimal: '.'; missing: NA; mode: numerical; separator: tab character)" />
 <param name="sampleMetadata_in" label="Sample metadata file" type="data" format="tabular" help="Samples x metadata (tabular data - decimal: '.'; missing: NA; mode: character or numerical; separator: tab character)" />
 <param name="variableMetadata_in" label="Variable metadata file (ideally from Univariate)" type="data" format="tabular" help="Features x metadata (tabular data - decimal: '.'; missing: NA; mode: character or numerical; separator: tab character)" />
 <param name="facC" label="Factor of interest" type="text" help="REQUIRED - The name of the column of sampleMetadata corresponding to the qualitative variable used to define the contrasts.  Except when the 'Univariate Significance-test' is set to 'none', this also must be a portion of the column names in the variableMetadata file."/>
-<param name="tesC" label="Univariate significance-test" type="select" help="Either 'none' or the name of the statistical test that was run by the 'Univariate' tool to produce the variableMetadata file; that name must also be a portion of the column names in that file.">
+<conditional name="signif_test">
-<option value="none">none - Display all features from variableMetadata (rather than choosing a subset based on significance in univariate testing)</option>
+			<param name="tesC" label="Univariate significance-test" type="select" help="Either 'none' or the name of the statistical test that was run by the 'Univariate' tool to produce the variableMetadata file; that name must also be a portion of the column names in that file.">
-<option value="ttest">ttest - Student's t-test (parametric test, qualitative factor with exactly 2 levels)</option>
+				<option value="none">none - Display all features from variableMetadata (rather than choosing a subset based on significance in univariate testing)</option>
-<option value="anova">anova - Analysis of variance (parametric test, qualitative factor with more than 2 levels)</option>
+				<option value="ttest">ttest - Student's t-test (parametric test, qualitative factor with exactly 2 levels)</option>
-<option value="wilcoxon">wilcoxon - Wilcoxon rank test (nonparametric test, qualitative factor with exactly 2 levels)</option>
+				<option value="anova">anova - Analysis of variance (parametric test, qualitative factor with more than 2 levels)</option>
-<option value="kruskal">kruskal - Kruskal-Wallis rank test (nonparametric test, qualitative factor with more than 2 levels)</option>
+				<option value="wilcoxon">wilcoxon - Wilcoxon rank test (nonparametric test, qualitative factor with exactly 2 levels)</option>
-</param>
+				<option value="kruskal">kruskal - Kruskal-Wallis rank test (nonparametric test, qualitative factor with more than 2 levels)</option>
-<param
+			</param>
-name="pairSigFeatOnly"
+			<when value="none" />
-type="boolean"
+			<when value="ttest">
-checked="true"
+				<expand macro="paramPairSigFeatOnly" />
-truevalue="TRUE"
+			</when>
-falsevalue="FALSE"
+			<when value="anova">
-label="Retain only pairwise-significant features"
+				<expand macro="paramPairSigFeatOnly" />
-help="When 'none' is chosen as the test, all features are included in the analysis (i. e., this parameter is ignored).  Otherwise, when this option is set to 'Yes', analysis will be performed including only features that differ significantly for the pair of levels being contrasted; when set to 'No', any feature that varies significantly across all levels will be included (i.e., exclude any feature that is not significantly different across all levels).  See examples below."/>
+			</when>
+			<when value="wilcoxon">
+				<expand macro="paramPairSigFeatOnly" />
+			</when>
+			<when value="kruskal">
+				<expand macro="paramPairSigFeatOnly" />
+			</when>
+</conditional>
 <param name="levCSV" label="Levels of interest" type="text" value = "*" help="Comma-separated level-names (or comma-less regular expressions to match level-names) to consider in analysis; must match at least two levels; levels must be non-numeric; may include wild cards or regular expressions.  Note that extra space characters will affect results - 'a,b' is correct, but 'a , b' is not and may fail or give different results.">
 <sanitizer>
 <valid initial="string.letters">
 <add preset="string.digits"/>
 <add value="&#36;"  /> <!-- $ dollar, dollar-sign -->
 <option value="none">do no generic matching (default)</option>
 <option value="wildcard" selected="true">use wild-cards for matching level-names</option>
 <option value="regex">use regular expressions for matching level-names</option>
 </param>
 <param name="labelFeatures" type="text" value="3" label="How many features having extreme loadings should be labelled on cov-vs.-cor plot" help="Specify the number of features at each of the loading-extremes that should be labelled (with the name of the feature) on the covariance-vs.-correlation plot; specify 'ALL' to label all features or '0' to label no features; this choice has no effect on the OPLS-DA loadings plot."/>
-<param
-name="labelOrthoFeatures"
-type="boolean"
-checked="false"
-truevalue="TRUE"
-falsevalue="FALSE"
-label="Label features having extreme orthogonal loadings"
-help="When using the preceding parameter to label only features at the loading-extremess in the cor-vs.-cov plot, use 'no' here to label only features having extreme parallel loadings (loadp); this is the default.  Choose 'yes' to add labels also to features having extreme orthogonal loadings (both loado and loadp); this may clutter the plot."/>
 </inputs>
 <outputs>
 <!--
 pdf1: summaries of each contrasts, clearly labelled by level=pair name
 <param name="variableMetadata_in" value="input_variableMetadata.tsv"/>
 <param name="tesC" value="kruskal"/>
 <param name="facC" value="k10"/>
 <param name="pairSigFeatOnly" value="FALSE"/>
 <param name="labelFeatures" value="3"/>
-<param name="labelOrthogonalFeatures" value="FALSE"/>
 <param name="levCSV" value="k[12],k[3-4]"/>
 <param name="matchingC" value="regex"/>
 <output name="contrast_corcov">
 <assert_contents>
 <!-- column-labels line -->
 <param name="variableMetadata_in" value="input_variableMetadata.tsv"/>
 <param name="tesC" value="kruskal"/>
 <param name="facC" value="k10"/>
 <param name="pairSigFeatOnly" value="TRUE"/>
 <param name="labelFeatures" value="3"/>
-<param name="labelOrthogonalFeatures" value="TRUE"/>
 <param name="levCSV" value="k[12],k[3-4]"/>
 <param name="matchingC" value="regex"/>
 <output name="contrast_corcov">
 <assert_contents>
 <!-- column-labels line -->
 <param name="dataMatrix_in" value="input_dataMatrix.tsv"/>
 <param name="sampleMetadata_in" value="input_sampleMetadata.tsv"/>
 <param name="variableMetadata_in" value="input_variableMetadata.tsv"/>
 <param name="tesC" value="none"/>
 <param name="facC" value="k10"/>
-<param name="pairSigFeatOnly" value="TRUE"/>
 <param name="labelFeatures" value="3"/>
-<param name="labelOrthogonalFeatures" value="FALSE"/>
 <param name="levCSV" value="k[12],k[3-4]"/>
 <param name="matchingC" value="regex"/>
 <output name="contrast_corcov">
 <assert_contents>
 <!-- column-labels line -->
 <has_text text="12.87766096" />
 </assert_contents>
 </output>
 </test>
 </tests>
-<!--
-.. |reg|    unicode:: U+000AE .. REGISTERED SIGN - see http://docutils.sourceforge.net/docutils/parsers/rst/include/isonum.txt or /usr/share/docutils/parsers/rst/include/isonum.txt
--->
 <help><![CDATA[
 **Run PLS-DA Contrasts of Univariate Results**
 ----------------------------------------------
 [IN] Factor of interest
 | Name of the **column of sampleMetadata** corresponding to the qualitative or quantitative variable
 |
 [IN] Retain only pairwise-significant features
+| *Note that when 'Test' is 'none', all features are included in the analysis and this parameter is not settable.*
 | When **true**, for each contrast of two levels, include only those features which pass the significance threshold for that contrast.  Choosing true results in an OPLS-DA model that better reflects and visualizes the difference detected by univariate analysis, with somewhat increased reliability of prediction (as assessed by cross-validation).
 | When **false**, include all features that pass the significance threshold when testing for difference across all factor-levels.  This choice produces a plot that displays more features but is not necessarily more informative.
-| *Note that when 'Test' is 'none', all features are included in the analysis and this parameter has no effect.*
 |
 [IN] Levels of interest
 | Comma-separated **level-names** (or comma-less regular expressions to match level-names) to consider in analysis; must match at least two levels; may include wild cards or regular expressions.
 |
 | Indicator of **how levels are to be specified generically** (if at all) - wild cards, regular expressions, or none (no generic matching).
 |
 [IN] Label how many extreme features
 | Specify the number of features at each of the loading-extremes that should be labelled (with the name of the feature) on the covariance-vs.-correlation plot; specify 'ALL' to label all features; this choice has no effect on the OPLS-DA loadings plot.
-|
-[IN] Label features with extreme loado
-| If the previous parameter has limited the the number of features to be labelled at each of the loading-extremes, then the extreme values for both loado and loadp will be labelled when this parameter is set to 'yes'; otherwise (in the default case) only extreme values for loadp will be lableld.  The default was chosen to make the plot less cluttered.
 |
 [OUT] Contrast-detail output PDF
 | Several plots for each two-projection OPLS-DA analysis:
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Level-name matching                        | use regular expressions for matching level-names                                                                                       |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Number of features having extreme loadings | ALL                                                                                                                                    |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
-| Label feat. having extreme orth. loadings  | Yes                                                                                                                                    |
-+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output primary table                       | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_corcov.tsv                    |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output salience table                      | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_salience.tsv                  |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output figures PDF                         | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_detail.pdf                    |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Level-name matching                        | use wild cards for matching level-names                                                                                                |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Number of features having extreme loadings | 5                                                                                                                                      |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
-| Label feat. having extreme orth. loadings  | No                                                                                                                                     |
-+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output primary table                       | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_corcov_all.tsv                |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output salience table                      | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_salience_all.tsv              |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output figures PDF                         | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_detail_all.pdf                |
 +============================================+========================================================================================================================================+
 | Factor of interest                         | k10                                                                                                                                    |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Univariate Significance-Test               | none                                                                                                                                   |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
-| Retain only pairwise-significant features  | No                                                                                                                                     |
-+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Levels of interest                         | k[12],k[3-4]                                                                                                                           |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Level-name matching                        | use regular expressions for matching level-names                                                                                       |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Number of features having extreme loadings | 0                                                                                                                                      |
-+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
-| Label feat. having extreme orth. loadings  | Yes                                                                                                                                    |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output primary table                       | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_corcov_global.tsv             |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output salience table                      | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_salience_global.tsv           |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 +============================================+========================================================================================================================================+
 | Factor of interest                         | lohi                                                                                                                                   |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Univariate Significance-Test               | none                                                                                                                                   |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
-| Retain only pairwise-significant features  | No                                                                                                                                     |
-+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Levels of interest                         | low,high                                                                                                                               |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Level-name matching                        | use regular expressions for matching level-names                                                                                       |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Number of features having extreme loadings | 3                                                                                                                                      |
-+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
-| Label feat. having extreme orth. loadings  | Yes                                                                                                                                    |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output primary table                       | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_corcov_lohi.tsv               |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 | Output salience table                      | https://raw.githubusercontent.com/HegemanLab/w4mcorcov_galaxy_wrapper/master/test-data/expected_contrast_salience_lohi.tsv             |
 +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
 Release notes
 -------------
+0.98.8
+- new feature: Replace loadings plot with correlation-versus-covariance plot for orthogonal features, i.e., the consistency of features influencing within-treatment variation (which is linearly related to the loading of the orthogonal projection) versus consistency.  This eliminates the need for the parameter to suppress labels for features with extreme orthogonal loadings
 0.98.7
-- bug fix: handle case of a treatment level with only one sample.
+- bug fix: Handle case of a treatment level with only one sample.
 0.98.6
-- bug fix: set 'crossvalI' param (of R function 'ropls::opls') to the number of samples when the there are fewer than seven samples.
+- bug fix: Set 'crossvalI' param (of R function 'ropls::opls') to the number of samples when the there are fewer than seven samples.
 0.98.5
-- bug fix: fit feature-labels within clipping region of cor-vs.cov plot
+- bug fix: Fit feature-labels within clipping region of cor-vs.cov plot
 - new feature: optionally (and by default) suppress labels for features with extreme orthogonal loadings
 0.98.3
-- add support for two-level factors
+- Add support for two-level factors
-- add adjusted mz and rt to output tables
+- Add adjusted mz and rt to output tables
-- allow explicitly setting the number of features with extreme loadings to be labelled on the correlation vs. covariance plot
+- Allow explicitly setting the number of features with extreme loadings to be labelled on the correlation vs. covariance plot
-- add loadings to corcov table
+- Add loadings to corcov table
 0.98.2
 - first release
 ]]></help>
 <citations>
+<!-- this tool -->
 <citation type="doi">10.5281/zenodo.1034784</citation>
 <!-- Galindo_Prieto_2014 Variable influence on projection (VIP) for OPLS -->
 <citation type="doi">10.1002/cem.2627</citation>
 <!-- Giacomoni_2014 W4M 2.5 -->
 <citation type="doi">10.1093/bioinformatics/btu813</citation>
 ]]></citation>
 <!-- Wiklund_2008 OPLS PLS-DA and S-PLOT -->
 <citation type="doi">10.1021/ac0713510</citation>
 </citations>
 <!--
-vim:noet:sw=4:ts=4
+vim:noet:sw=2:ts=2
 -->
 </tool>

Mercurial > repos > eschen42 > w4mcorcov

comparison w4mcorcov.xml @ 5:50f60f94c034 draft