diff SMART/galaxy/getDistance.xml @ 15:440ceca58672

Uploaded
author m-zytnicki
date Mon, 22 Apr 2013 11:08:07 -0400
parents 769e306b7933
children 94ab73e8a190
line wrap: on
line diff
--- a/SMART/galaxy/getDistance.xml	Fri Apr 19 10:13:11 2013 -0400
+++ b/SMART/galaxy/getDistance.xml	Mon Apr 22 11:08:07 2013 -0400
@@ -1,5 +1,5 @@
 <tool id="GetDistance" name="get distance">
-	<description>Give the distances between every data from the first input set and the data from the second input set</description>
+	<description>Give the distances between every data from the first input set with respect to the data from the second input set.</description>
 	<command interpreter="python">
 		../Java/Python/getDistance.py -i $formatType.inputFileName1
 		#if $formatType.FormatInputFileName1 == 'bed':
@@ -40,16 +40,6 @@
 			-a
 		#end if
 
-		#if $OptionFirstNucl5.FirstNu5 == "Yes":
-			-s $OptionFirstNucl5.first5File1
-			-S $OptionFirstNucl5.first5File2
-		#end if		
-
-		#if $OptionFirstNucl3.FirstNu3 == "Yes":
-			-e $OptionFirstNucl3.first3File1
-			-E $OptionFirstNucl3.first3File2
-		#end if
-
 		#if $OptionMinDistance.MinD == "Yes":
 			-m $OptionMinDistance.minDistance
 		#end if
@@ -77,8 +67,6 @@
 		#end if
 		
 		-o $outputFilePng
-		$outputDistance $outputFileDistance
-
 	</command>
 
 	<inputs>
@@ -140,14 +128,12 @@
 			</when>
 		</conditional>
 
-		<param name="outputDistance" type="boolean" truevalue="-O" falsevalue="" checked="false" label="distance option" help="This option create a GFF3 output file containing the distance for each element of the query."/>
-
 		<param name="absolute" type="boolean" truevalue="-b" falsevalue="" checked="false" label="absolute value option" help="This option gives the absolute value of the distance."/>
 		<param name="proportion" type="boolean" truevalue="-p" falsevalue="" checked="false" label="proportion option" help="This option gives the proportion on the y-axis instead of the number of distances."/>
 
 		<conditional name="OptionColinearOrAntiSens">
-			<param name="OptionCA" type="select" label="Colinear or anti-sens">
-				<option value="Colinear">Colinear</option>
+			<param name="OptionCA" type="select" label="Provide distribution of distances between collinear/antisense pairs of features">
+				<option value="Colinear">Collinear</option>
 				<option value="AntiSens">AntiSens</option>
 				<option value="NONE" selected="true">NONE</option>
 			</param>
@@ -159,34 +145,8 @@
 			</when>
 		</conditional>
 
-		<conditional name="OptionFirstNucl5">
-			<param name="FirstNu5" type="select" label="only consider the n first 5' nucleotides for input files">
-				<option value="Yes">Yes</option>
-				<option value="No" selected="true">No</option>
-			</param>
-			<when value="Yes">
-				<param name="first5File1" type="integer" value="1" label="in file 1" help="Be Careful! The value must be upper than 0"/>
-				<param name="first5File2" type="integer" value="1" label="in file 2" help="Be Careful! The value must be upper than 0"/>
-			</when>
-			<when value="No">
-			</when>
-		</conditional>
-
-		<conditional name="OptionFirstNucl3">
-			<param name="FirstNu3" type="select" label="only consider the n first 3' nucleotides for input files">
-				<option value="Yes">Yes</option>
-				<option value="No" selected="true">No</option>
-			</param>
-			<when value="Yes">
-				<param name="first3File1" type="integer" value="1" label="in file 1" help="Be Careful! The value must be upper than 0"/>
-				<param name="first3File2" type="integer" value="1" label="in file 2" help="Be Careful! The value must be upper than 0"/>
-			</when>
-			<when value="No">
-			</when>
-		</conditional>
-
 		<conditional name="OptionMinDistance">
-			<param name="MinD" type="select" label="minimum distance considered between two transcripts">
+			<param name="MinD" type="select" label="Minimum distance between two features">
 				<option value="Yes">Yes</option>
 				<option value="No" selected="true">No</option>
 			</param>
@@ -198,7 +158,7 @@
 		</conditional>
 
 		<conditional name="OptionMaxDistance">
-			<param name="MaxD" type="select" label="maximum distance considered between two transcripts">
+			<param name="MaxD" type="select" label="Maximum distance between two features">
 				<option value="Yes">Yes</option>
 				<option value="No" selected="true">No</option>
 			</param>
@@ -267,9 +227,18 @@
 
 	<outputs>
 		<data name="outputFilePng" format="png"/>
-		<data name="outputFileDistance" format="gff3">
-			<filter>outputDistance</filter>
-		</data>
 	</outputs> 
 
+	<help>
+Give the distances between every data from the first input set and the data from the second input set. It outputs the size distribution. Each point (*x*, *y*) tells you that there exists *y* pairs of elements which are separated by *x* nucleotides.
+
+The general algorithm is the following. For each element of the first input set, it finds the closest element of the second set and computes the distance between the two elements. The distance is zero if the two elements overlap. This distance may not exist if the element of the first input set is alone on its chromosome (or contig).
+
+Actually, considering an element from the first input set, the algorithm will look at the vicinity of this element (1kb by default). You can increase the size of the vicinity using the appropriate option.
+
+As in *compare overlapping*, you can shrink or extend your sets of genomic coordinates, so that you can get the distance between starts of reads and starts or genes, for instance. You can also compute the distance from elements which are on the same strand only (which is not the case by default) or on the opposite strand only.
+
+You have several options for the output plot. You can first choose the region on the *x*-axis you want to plot. You can also display histograms instead of line plot. In this case, the data are summed into buckets, whose sizes are given as an option. For instance, a bucket of size *s* at the point (*x*, *y*) means that there are *y* pairs of elements which are separated by *x* to *x + s* nucleotides.
+	</help>
+
 </tool>