diff isoem2_isode2/isoDE.xml @ 12:be08c88b353e draft

Added Sample names input parameter to be appended to the output file names

--- a/isoem2_isode2/isoDE.xml	Fri Mar 17 06:47:46 2017 -0400
+++ b/isoem2_isode2/isoDE.xml	Sun Mar 26 22:27:30 2017 -0400
@@ -1,5 +1,5 @@
 <tool id="isoDE" name="IsoDE2">
-  <description>Compute gene Differential Expression based on IsoEM2 output </description>
+  <description>Computes differentially expressed isoforms and genes based on bootstrap samples generated by IsoEM2 </description>
   <command interpreter="bash">isoDE2.sh
       -c1
       $condition1
@@ -19,7 +19,9 @@
  </command>
 
   <inputs>
-  <param name="condition1" type="data" label="Select data for Condition 1" format="gz" help="Condition 1 isoEM2 compressed output file"/>
+    <param name="sampleName1"  size="10" type="text"  label="Name for Condition 1" value="Condition1"/>
+
+    <param name="condition1" type="data" label="Select data for Condition 1" format="gz" help="Condition 1 isoEM2 compressed output file"/>
 <!--
     <param format="toolshed.gz" name="condition1" type="data" label="Select data for Condition 1" help="Condition 1 isoEM2 compressed output file"/>
 -->
@@ -27,6 +29,8 @@
       <param name="c1Rep" label="Add replicate" type="data" format="gz" data_ref="condtion1" />
     </repeat>
 
+    <param name="sampleName2"  size="10" type="text"  label="Name for Condition 2" value="Condition2"/>
+
     <param format="gz" name="condition2" type="data" label="Select data for Condition 2"  help="Condition 2 isoEM2 compressed output file"/>
 <!--
     <param  format="toolshed.gz" name="condition2" type="data" label="Select data for Condition 2" help="Condition 2 IsoEM2 compressed output file"/>
@@ -40,22 +44,23 @@
 
   </inputs>
   <outputs>
-    <data format="tabular" name="geneFPKM" label="isoDE gene fpkm"  />
-    <data format="tabular" name="isoformFPKM" label="isoDE isoform fpkm"  />
-    <data format="tabular" name="geneTPM" label="isoDE gene tpm"  />
-    <data format="tabular" name="isoformTPM" label="isoDE isoform tpm"  />
+    <data format="tabular" name="geneFPKM" label="${sampleName1}.vs.${sampleName2} isoDE gene fpkm "  />
+    <data format="tabular" name="isoformFPKM" label="${sampleName1}.vs.${sampleName2} isoDE isoform fpkm "  />
+    <data format="tabular" name="geneTPM" label="${sampleName1}.vs.${sampleName2} isoDE gene tpm "  />
+    <data format="tabular" name="isoformTPM" label="${sampleName1}.vs.${sampleName2} isoDE isoform tpm "  />
   </outputs>
 
 <help>
 **What it does**
 
-Computes gene and isoform differential expression between two conditions (example tumor and normal) for both Fragment per Kilobase of transcript length per Million 
-bases (FPKM) and Transcripts per Million (TPM) values. The computation is based on the boostraping output generated by IsoEM2. 
+IsoDE2 computes isoforms and genes that are differentially expressed between two conditions (e.g., treated vs. control). 
+The computation is based on the boostrap samples generated by IsoEM2. 
 
 **Input**
 
-* - One or more IsoEM output files (compressed tar files) for each of the two conditions. More than one file can be used if there are replicated for either condition
-* - Desired Significance level for which a reliable fold change level will be reported
+* 1- Names for the two conditions (the default values 'Condition 1' and 'Condition 2' will be used in the output file names if these are not specified)
+* 2- One or more IsoEM output files (compressed tar files) for each of the two conditions. Multiple files can be used when IsoEM2 is run independently on replicates for each condition.
+* 3- Desired significance level for which a reliable fold change level will be reported.
 *
 
 
@@ -63,16 +68,13 @@
 
 **Output**
 
-* four output files containinag results for Gene FPKM DE, Gene TPM DE, Isoform FPKM DE, and Isoform TPM DE. The four files have identical format with the following fields
-* 1- Gene/isoform ID
-* 2- Conservative log_2(FC) : conservative estimate of fold change in log base 2. 
-*               For the confidence level as input, fold change of gene/isoform abundance (FPKM/TPM) in condition 2 compared condition 1 is 
-*               at least 2 ^ absoulte value of this field.The sign indicates the direction, +ve means over expressed in condition 2, -ve means underexpressed in
-*               condition 1. 0 indicates that no change was detected.
-* 3- log_2(condition 2 FPKM (or TPM)/condition 1 FPKM(or TPM)) based on IsoEM2 run without bootstrapping (average FPKM or TPM if replicates used)
-* 4- condition 1 FPKM (or TPM) based on IsoEM2 run without bootstrapping (average if replicates used)
-* 5- condition 2 FPKM (or TPM) based on IsoEM2 run without bootstrapping (average if replicates used)
- 
+* Four output files containinag results of isoform and gene differential expression analysis based on both Fragments per Kilobase per Million (FPKM) and Transcripts per Million (TPM) expression levels. The four tab delimited files have identical format with the following fields:
+* 1- Isoform/Gene ID
+* 2- Confident log_2(FC): the base 2 logarithm of the largest fold change of isoform/gene FPKM/TPM estimates of condition 2 vs condition 1 which is supported by the provided bootstrap samples at the specified significance level. Positive values represent over-expression in Condition 2, while negative values representing over-expression in Condition 1. A zero value in this field indicates that no significant change was detected.
+* 3- Single run log2(FC): the base 2 logarithm of the ratio between expression levels estimated by IsoEM2 for Condition 2 and Condition 1 (ratio between mean estimates in case replicates are provided for the two conditions).
+* 4- Condition 1 FPKM or TPM: the IsoEM2 expression level estimated for Condition 1 (mean value in case of replicates).
+* 5- Condition 2 FPKM or TPM: the IsoEM2 expression level estimated for Condition 2 (mean value in case of replicates).
+*
 
 </help>
 </tool>