diff isocor.xml @ 1:fa183805db31 draft default tip

"planemo upload"
author gmat
date Mon, 04 May 2020 11:38:09 -0400
parents 96f7617b4848
children
line wrap: on
line diff
--- a/isocor.xml	Mon May 27 03:33:36 2019 -0400
+++ b/isocor.xml	Mon May 04 11:38:09 2020 -0400
@@ -1,22 +1,22 @@
-<tool id="isocor" name="Isotope Correction for mass spectrometry labeling experiments" version="0.1.2">
+<tool id="isocor" name="Isotope Correction for mass spectrometry labeling experiments" version="0.1.3">
     <requirements>
-        <requirement type="package" version="2.1.3">isocor</requirement>
+        <requirement type="package" version="2.2.0">isocor</requirement>
     </requirements>
     <command detect_errors="exit_code"><![CDATA[
-        isocorcli -t "$tracer" -M "$input1" -D "$input2" -I "$input3"
-#if $tracer_purity:
-    -p $tracer_purity
+        isocorcli -t "$tracer" -M "$db.input1" -D "$db.input2" -I "$db.input3"
+#if $tcorrection.tracer_purity:
+    -p $tcorrection.tracer_purity
 #end if
-#if $resolution:
-    -r $resolution
+#if $HR.resolution:
+    -r $HR.resolution
 #end if
-#if $mz:
-    -m $mz
+#if $HR.mz:
+    -m $HR.mz
 #end if 
-#if $resolution_formula_code:
-    -f $resolution_formula_code
+#if $HR.resolution_formula_code:
+    -f $HR.resolution_formula_code
 #end if
-#if $correct_na_tracer:
+#if $tcorrection.correct_na_tracer:
     -n
 #end if
 #if $verbose_log:
@@ -26,45 +26,81 @@
     ]]></command>
     <inputs>
         <param type="text" name="tracer" argument="-t" label="the isotopic tracer (e.g. '13C')" />
-        <param type="data" name="input1" argument="-M" label="metabolites db" format="tabular" />
-        <param type="data" name="input2" argument="-D" label="derivatives db" format="tabular" />
-        <param type="data" name="input3" argument="-I" label="isotopes db" format="csv" />
-        <param type="integer" optional="true" argument="-r" name="resolution" label="HR only: resolution of the mass spectrometer (e.g. 1e4)" />
-        <param type="integer" optional="true" argument="-m" name="mz" label="HR only: mz at which resolution is given (e.g. '400')" />
-        <param type="boolean" optional="true" argument="-n" name="correct_na_tracer" label="flag to correct tracer natural abundance" />
-        <param type="boolean" optional="true" argument="-v" name="verbose_log" label="flag to enable verbose logs" />
-        <param type="text" optional="true" argument="-p" name="tracer_purity" label="purity vector of the tracer" />
+        <param type="data" name="input4" label="measurements Data file" format="tabular" help="This file contains the raw MS data for each metabolite of each sample." />
+        <section name="db" title="Database Files" expanded="true" help="The exact mass and natural abundance of each isotope and the elemental formulas used for correction have to be defined carefully, otherwise the correction will be wrong. IsoCor rely on several flat-files to store this information. Pre-configured files are shipped with IsoCor. For a good start download them on github">
+            <param type="data" name="input1" argument="-M" label="metabolites db" format="tabular" />
+            <param type="data" name="input2" argument="-D" label="derivatives db" format="tabular" />
+            <param type="data" name="input3" argument="-I" label="isotopes db" format="csv" />
+        </section>
+        <section name="HR" title="High Resolution Parameters" expanded="true" help="For measurements collected at high or ultrahigh resolution (e.g. on Orbitrap or FT-ICR instruments). Measurements collected at unitary resolution (e.g. on quadrupole instruments) are Low Resolution, don't fill this section.">
+            <param name="resolution_formula_code" optional="true" argument="-f" type="select" label="HR only: spectrometer formula code">
+                <option value="orbitrap">Orbitrap</option>
+                <option value="ft-icr">ft-icr</option>
+                <option value="constant">Constant</option>
+                <option value="datafile">Datafile</option>
+            </param>
+            <param type="integer" optional="true" argument="-r" name="resolution" label="HR only: resolution of the mass spectrometer (e.g. '60000' or '1e4')" />
+            <param type="integer" optional="true" argument="-m" name="mz" label="HR only: mz at which resolution is given (e.g. '400')" />
+        </section>
+        <section name="tcorrection" title="Tracer Correction Options" expanded="true">
+            <param type="boolean" optional="true" argument="-n" name="correct_na_tracer" label="flag to correct tracer natural abundance" help="Correct for the contribution of naturally occurring isotopes of the tracer element at unlabeled positions. This only concerns the tracer element: natural abundance of other elements is always corrected." />
+            <param type="text" optional="true" argument="-p" name="tracer_purity" label="purity vector of the tracer (e.g. '0,0,0.99,0.01')" help="Correct for the contribution of isotopic impurities of the tracer at labeled positions. The isotopic purity is typically obtained from the manufacturer. e.g. ¹³C-substates with purity of 99%, use 0.01 for ¹²C and 0.99 for ¹³C." />
+        </section>
+        <param type="boolean" optional="true" argument="-v" name="verbose_log" label="flag to enable verbose logs" help="Useful in case of trouble. Join it to the issue on github." />
 
-	<param name="resolution_formula_code" optional="true" argument="-f" type="select" label="HR only: spectrometer formula code">
-		<option value="orbitrap">Orbitrap</option>
-  		<option value="ft-icr">ft-icr</option>
-  		<option value="constant">Constant</option>
-  		<option value="datafile">Datafile</option>
-	</param>
 
-        <param type="data" name="input4" label="measurements Data file" format="tabular" />
     </inputs>
     <outputs>
-        <data name="output1" label="corrected measurements data file" format="csv" />
+        <data name="output1" label="corrected measurements data file" format="tabular" />
         <data name="output2" label="processing log file" format="txt" />
     </outputs>
     <tests>
         <test>
             <param name="tracer" value="13C"/>
-            <param name="input1" value="Metabolites.dat"/>
-            <param name="input2" value="Derivatives.dat"/>
-            <param name="input3" value="Isotopes.dat"/>
+            <section name="db">
+                <param name="input1" value="Metabolites.dat"/>
+                <param name="input2" value="Derivatives.dat"/>
+                <param name="input3" value="Isotopes.dat"/>
+            </section>
             <param name="input4" value="Data_example.tsv"/>
             <output name="output1">
-		<assert_contents>
-			<has_n_columns n="9" />
-		</assert_contents>
-	    </output>
+                <assert_contents>
+                    <has_n_columns n="10" />
+                </assert_contents>
+	        </output>
             <output name="output2">
-		<assert_contents>
-			<has_text text="- root - INFO -    errors: 0" />
-		</assert_contents>
-	    </output>
+		        <assert_contents>
+	        		<has_text text="- root - INFO -    errors: 0" />
+	        	</assert_contents>
+	        </output>
+        </test>
+        <test>
+            <param name="tracer" value="13C"/>
+            <section name="db">
+                <param name="input1" value="Metabolites.dat"/>
+                <param name="input2" value="Derivatives.dat"/>
+                <param name="input3" value="Isotopes.dat"/>
+            </section>
+            <section name="HR">
+                <param name="mz" value="400"/>
+                <param name="resolution" value="60000"/>
+                <param name="resolution_formula_code" value="orbitrap"/>
+            </section>
+            <section name="tcorrection">
+                <param name="correct_na_tracer" value="-n"/>
+                <param name="tracer_purity" value="0.01,0.99"/>
+            </section>
+            <param name="input4" value="Data_example.tsv"/>
+            <output name="output1">
+                <assert_contents>
+                    <has_n_columns n="10" />
+                </assert_contents>
+	        </output>
+            <output name="output2">
+		        <assert_contents>
+	        		<has_text text="- root - INFO -    errors: 0" />
+	        	</assert_contents>
+	        </output>
         </test>
     </tests>
     <help><![CDATA[