changeset 5:2cdf7d5982c8 draft

planemo upload for repository https://github.com/HegemanLab/w4mclassfilter_galaxy_wrapper/tree/master commit a2d17eac4a1343a34cf2908d9ab31b3202a21f64
author eschen42
date Thu, 07 Sep 2017 17:41:09 -0400
parents 499c7ecfa834
children 38ccf6722d54
files test-data/input_nofilter_dataMatrix.tsv w4mclassfilter.xml
diffstat 2 files changed, 104 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test-data/input_nofilter_dataMatrix.tsv	Thu Sep 07 17:41:09 2017 -0400
@@ -0,0 +1,16 @@
+dataMatrix	HU_017	HU_028	HU_034	HU_051	HU_060	HU_078	HU_091	HU_093	HU_099	HU_110	HU_130	HU_134	HU_138	HU_149	HU_152	HU_175	HU_178	HU_185	HU_204	HU_208
+HMDB03193	76043	412165	44943	27242	436566	173175	242549	57066	559869	3732	339188	471368	262271	127285	451270	212500	79673	NA	891129	43907
+HMDB01101	30689	6877586	52217	3158	10789748	229568	4763576	3878773	976436	831937	608298	1605075	72021	442510	1107705	1464339	31250	2724553	891129	32742
+HMDB01101	6877586	52217	3158	10789748	229568	4763576	3878773	976436	831937	608298	1605075	72021	442510	1107705	1464339	31250	2724553	72900	891129	30689
+HMDB10348	47259	544877	60885	34582	529874	168264	176500	76457	610110	16262	279156	524468	451573	591487	433529	161069	214392	13781	891129	39315
+HMDB59717	357351	1030464	301983	67604	306862	1028110	1530493	270027	1378535	289677	808334	1132813	871209	895435	715190	1563158	784738	146195	891129	239030
+HMDB00822	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627	14627
+HMDB00299	250551	1046138	456162	159386	1013302	808657	614370	250403	768004	242085	504108	1014041	1362408	1057660	1110050	566050	411886	142233	891129	284775
+HMDB00191	560002	771533	575790	392284	888498	785428	645785	591569	960658	910201	639437	1092885	1409045	2292023	1246459	1945577	710519	773384	891129	622898
+HMDB00518	-34236	58249	85944	NA	342102	129886	175800	13154	230242	NA	440223	315368	10657	419508	48673	28361	514579	23108	891129	73831
+HMDB00715	1252089	2547452	905408	371059	4983588	5140022	2658555	814523	2558923	859466	4184204	3865723	3236644	2615560	3820724	3577833	2295288	625924	891129	1341900
+HMDB01032	2569205	26023086	1604999	430453	8103558	26222916	257139	675754	59906109	263055	31151730	18648127	14989438	1554658	20249262	5588731	871010	15920	891129	44276
+HMDB00208	747080	13420742	595872	1172376	7172632	3143654	4059767	1433702	5593888	5402629	2477288	3346077	4230072	7621236	8960828	10335722	7037373	1574738	891129	2540044
+HMDB04824	374028	1144386	539206	178517	1046190	959381	605191	310260	1253319	477259	477995	825691	1157093	1089284	1411802	1020206	782673	346761	891129	387811
+HMDB00512	NA	319783	280560	85009	1333877	556003	590779	209285	342532	198512	569970	525240	246282	1140422	542345	1171008	827723	222953	891129	85554
+HMDB00251	368600	616555	94936	622468	180988	293988	352855	767894	268331	167246	310918	1248919	577184	10985	335711	403815	80614	63393	891129	616061
--- a/w4mclassfilter.xml	Mon Jun 19 23:42:33 2017 -0400
+++ b/w4mclassfilter.xml	Thu Sep 07 17:41:09 2017 -0400
@@ -1,10 +1,10 @@
-<tool id="w4mclassfilter" name="Sample_Subset" version="0.98.2">
+<tool id="w4mclassfilter" name="Sample_Subset" version="0.98.3">
   <description>Filter W4M data by sample class</description>
 
   <requirements>
-    <requirement type="package" version="3.3.1">r-base</requirement>
+    <requirement type="package" version="3.3.2">r-base</requirement>
     <requirement type="package" version="1.1_4">r-batch</requirement>
-    <requirement type="package" version="0.98.2">w4mclassfilter</requirement>
+    <requirement type="package" version="0.98.3">w4mclassfilter</requirement>
   </requirements>
 
   <stdio>
@@ -34,7 +34,29 @@
     <param name="samplenameColumn" label="Column that names the sample" type="text" value = "sampleMetadata" help="name of the column in the sample metadata file that has the name of the sample - defaults to 'sampleMetadata'" />
     <param name="classnameColumn" label="Column that names the sample-class" type="text" value = "class" help="name of the column in sample metadata that has the values to be tested against the 'classes' input parameter - defaults to 'class'" />
     <param name="sampleclassNames" label="Names of sample classes" type="text" value = "" help="comma-separated names (or comma-less regular expressions to match names) of sample-classes to filter in or out; defaults to no names">
-      <sanitizer sanitize="False"/>
+      <sanitizer>
+        <valid initial="string.letters">
+          <add preset="string.digits"/>
+          <add value="&#36;"  /> <!-- dollar, dollar-sign -->
+          <add value="&#40;"  /> <!-- left-paren -->
+          <add value="&#41;"  /> <!-- right-paren -->
+          <add value="&#42;"  /> <!-- splat, asterisk -->
+          <add value="&#43;"  /> <!-- plus -->
+          <add value="&#44;"  /> <!-- comma -->
+          <add value="&#46;"  /> <!-- dot, period -->
+          <add value="&#58;"  /> <!-- colon -->
+          <add value="&#59;"  /> <!-- semi, semicolon -->
+          <add value="&#63;"  /> <!-- what, question mark -->
+          <add value="&#91;"  /> <!-- l-squib, left-squre-bracket -->
+          <add value="&#92;"  /> <!-- whack, backslash -->
+          <add value="&#93;"  /> <!-- r-squib, right-squre-bracket -->
+          <add value="&#94;"  /> <!-- hat, caret -->
+          <add value="&#123;" /> <!-- l-cube, left-curly-bracket -->
+          <add value="&#124;" /> <!-- pipe -->
+          <add value="&#125;" /> <!-- r-cube, right-curly-bracket -->
+        </valid>
+      </sanitizer>
+
     </param>
     <param name="wildcards" label="Use wild-cards or regular-expressions" type="select" help="wild-cards (the default) - use '*' and '?' to match class names; regular-expressions - use comma-less regular expressions to match class names">
       <option value="TRUE" selected="true">wild-cards</option>
@@ -106,7 +128,42 @@
       <param name="sampleMetadata_in" value="input_sampleMetadata.tsv"/>
       <param name="variableMetadata_in" value="input_variableMetadata.tsv"/>
       <param name="classnameColumn" value="gender"/>
+      <param name="sampleclassNames" value="*"/>
+      <param name="wildcards" value="TRUE"/>
+      <param name="samplenameColumn" value="sampleMetadata"/>
+      <param name="inclusive" value="filter-in"/>
+      <output name="sampleMetadata_out">
+        <assert_contents>
+          <not_has_text text="HU_204" />
+          <has_text text="HU_028" />
+          <has_text text="HU_051" />
+          <has_text text="HU_060" />
+          <has_text text="HU_110" />
+          <has_text text="HU_149" />
+          <has_text text="HU_152" />
+          <has_text text="HU_175" />
+          <has_text text="HU_178" />
+          <has_text text="HU_185" />
+          <has_text text="HU_208" />
+          <has_text text="HU_017" />
+          <has_text text="HU_034" />
+          <has_text text="HU_078" />
+          <has_text text="HU_091" />
+          <has_text text="HU_093" />
+          <has_text text="HU_099" />
+          <has_text text="HU_130" />
+          <has_text text="HU_134" />
+          <has_text text="HU_138" />
+        </assert_contents>
+      </output>
+    </test>
+    <test>
+      <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="classnameColumn" value="gender"/>
       <param name="sampleclassNames" value="M"/>
+      <param name="wildcards" value="FALSE"/>
       <param name="samplenameColumn" value="sampleMetadata"/>
       <param name="inclusive" value="filter-in"/>
       <output name="sampleMetadata_out">
@@ -140,6 +197,7 @@
       <param name="variableMetadata_in" value="input_variableMetadata.tsv"/>
       <param name="classnameColumn" value="gender"/>
       <param name="sampleclassNames" value="M"/>
+      <param name="wildcards" value="FALSE"/>
       <param name="samplenameColumn" value="sampleMetadata"/>
       <param name="inclusive" value="filter-in"/>
       <output name="variableMetadata_out">
@@ -169,6 +227,7 @@
       <param name="variableMetadata_in" value="input_variableMetadata.tsv"/>
       <param name="classnameColumn" value="gender"/>
       <param name="sampleclassNames" value="M"/>
+      <param name="wildcards" value="FALSE"/>
       <param name="samplenameColumn" value="sampleMetadata"/>
       <param name="inclusive" value="filter-in"/>
       <output name="variableMetadata_out">
@@ -198,6 +257,7 @@
       <param name="variableMetadata_in" value="input_variableMetadata.tsv"/>
       <param name="classnameColumn" value="gender"/>
       <param name="sampleclassNames" value="[Mm],[fF]"/>
+      <param name="wildcards" value="FALSE"/>
       <param name="samplenameColumn" value="sampleMetadata"/>
       <param name="inclusive" value="filter-in"/>
       <output name="sampleMetadata_out">
@@ -231,6 +291,7 @@
       <param name="variableMetadata_in" value="input_variableMetadata.tsv"/>
       <param name="classnameColumn" value=""/>
       <param name="sampleclassNames" value="M"/>
+      <param name="wildcards" value="FALSE"/>
       <param name="samplenameColumn" value="sampleMetadata"/>
       <param name="inclusive" value="filter-in"/>
       <output name="sampleMetadata_out">
@@ -262,11 +323,10 @@
 
 
 
-	<help>
-		<![CDATA[
+  <help><![CDATA[
 
 
-**Author**	Arthur Eschenlauer (University of Minnesota, esch0041@umn.edu)
+**Author** Arthur Eschenlauer (University of Minnesota, esch0041@umn.edu)
 
 --------------------------------------------------------------------------
 
@@ -309,11 +369,11 @@
 Data for a sample are collected as MS intensities, each of which is associated with a position on a 2D plane with dimensions of m/z ratio and chromatographic retention time.
 Ideally, features would be sufficiently reproducible from sample-run to sample-run to identify features that are commmon among samples and those that differ.
 However, the chromatographic retention time for a chemical can vary from one run to another.
-In the Workflow4Metabolomics (W4M, [Giacomoni *et al.*, 2014]) "flavor" of Galaxy, the XCMS [Smith *et al.*, 2006] preprocessing tools provide for "retention time correction" to align features among samples, but features may be better aligned if pooled samples and blanks are included.
+In the Workflow4Metabolomics (W4M, [Giacomoni *et al.*, 2014, Guitton *et al.* 2017]) "flavor" of Galaxy, the XCMS [Smith *et al.*, 2006] preprocessing tools provide for "retention time correction" to align features among samples, but features may be better aligned if pooled samples and blanks are included.
 
 Multivariate statistical techniques may be used to discover clusters of similar samples, and sometimes it is desirable to apply clustering iteratively to smaller and smaller subsets of samples until observable separation of clusters is no longer significant.
 Once feature-alignment has been achieved among samples in GC-MS and LC-MS datasets, however, the presence of pools and blanks may confound identification and separation of clusters.
-Multivariate statistical algorithms also may be impacted by missing values or dimensions that have zero variance.
+Multivariate statistical algorithms also may be impacted by missing values or dimensions that have zero variance (Thévenot *et al.*, 2015).
 
 The w4mclassfilter tool provides a way to choose subsets of samples for further analysis.
 The tool takes as input the data matrix, sample metadata, and variable metadata Galaxy datasets produced by W4M and produces the same trio of datasets with data only for the selected samples.
@@ -400,7 +460,7 @@
 Wild card patterns to match class-names
 ---------------------------------------
 
-Beginning with v0.98.2, w4mclassfilter supports use of R regular expression patterns to select class-names.
+Beginning with v0.98.2, w4mclassfilter supports use of R "wild card" patterns to select class-names.
 
 - use '``?``' to match a single character
 - use '``*``' to match zero or more characters
@@ -416,7 +476,7 @@
 Regular expression patterns to match class-names
 ------------------------------------------------
 
-Beginning with v0.98.2, w4mclassfilter supports use of R regular expression patterns to select class-names.
+Beginning with v0.98.2, w4mclassfilter supports use of R "regular expression" patterns to select class-names.
 
 R uses POSIX 1003.2 standard regular expressions, which allow precise pattern-matching and are exhaustively defined at:
 http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html
@@ -508,6 +568,15 @@
 NEWS
 ----
 
+CHANGES IN VERSION 0.98.3
+=========================
+
+INTERNAL MODIFICATIONS
+
+* Improved input handling.
+* Now uses w4mclassfilter R package v0.98.3, although that version has no functional implications for this tool.
+* Improved reference-list.
+
 CHANGES IN VERSION 0.98.2
 =========================
 
@@ -536,11 +605,16 @@
 
 none
 
-    ]]>
-  </help>
+  ]]></help>
   <citations>
+    <!-- Giacomoni_2014 W4M 2.5 -->
+    <citation type="doi">10.1093/bioinformatics/btu813</citation>
+    <!-- Guitton_2017 W4M 3.0 -->
+    <citation type="doi">10.1016/j.biocel.2017.07.002</citation>
+    <!-- Smith_2006 XCMS -->
     <citation type="doi">10.1021/ac051437y</citation>
-    <citation type="doi">10.1093/bioinformatics/btu813</citation>
+    <!-- Th_venot_2015 Urinary metabolome statistics -->
+    <citation type="doi">10.1021/acs.jproteome.5b00354</citation>
   </citations>
   <!--
      vim:noet:sw=4:ts=4