annotate SMART/galaxy/compareOverlapping.xml @ 18:94ab73e8a190

Uploaded

<tool id="CompareOverlapping" name="compare overlapping">
	<description>Print all the transcripts from a first file which overlap with the transcripts from a second file.</description>
	<requirements>
		<requirement type="set_environment">PYTHONPATH</requirement>
	</requirements>
	<command interpreter="python">
		../Java/Python/CompareOverlapping.py -i $formatType.inputFileName1
		#if $formatType.FormatInputFileName1 == 'bed':
			-f bed
		#elif $formatType.FormatInputFileName1 == 'gff':
			-f gff	
		#elif $formatType.FormatInputFileName1 == 'gff2':
			-f gff2
		#elif $formatType.FormatInputFileName1 == 'gff3':
			-f gff3
		#elif $formatType.FormatInputFileName1 == 'sam':
			-f sam
		#elif $formatType.FormatInputFileName1 == 'gtf':
			-f gtf
		#end if
			
		-j $formatType2.inputFileName2
		#if $formatType2.FormatInputFileName2 == 'bed':
			-g bed
		#elif $formatType2.FormatInputFileName2 == 'gff':
			-g gff	
		#elif $formatType2.FormatInputFileName2 == 'gff2':
			-g gff2
		#elif $formatType2.FormatInputFileName2 == 'gff3':
			-g gff3
		#elif $formatType2.FormatInputFileName2 == 'sam':
			-g sam
		#elif $formatType2.FormatInputFileName2 == 'gtf':
		    -g gtf
		#end if

		-o $outputFileGff 

		#if $optionNFirstFile1.NFirstForFile1 == 'Yes':
			-S $optionNFirstFile1.firstNtFile1
		#end if
		#if $optionNFirstFile2.NFirstForFile2 == 'Yes':
			-s $optionNFirstFile2.firstNtFile2
		#end if
		#if $optionNLastFile1.NLastForFile1 == 'Yes':
			-U $optionNLastFile1.lastNtFile1
		#end if
		#if $optionNLastFile2.NLastForFile2 == 'Yes':
			-u $optionNLastFile2.lastNtFile2
		#end if
	
		#if $optionExtentionCinqFile1.extentionFile1 == 'Yes':
			-E $optionExtentionCinqFile1.extention51
		#end if
		#if $optionExtentionCinqFile2.extentionFile2 == 'Yes':
			-e $optionExtentionCinqFile2.extention52
		#end if

		#if $optionExtentionTroisFile1.extentionFile1 == 'Yes':
			-N $optionExtentionTroisFile1.extention31
		#end if
		#if $optionExtentionTroisFile2.extentionFile2 == 'Yes':
			-n $optionExtentionTroisFile2.extention32
		#end if	

		#if $OptionColinearOrAntiSens.OptionCA == 'Colinear':
			-c 
		#elif $OptionColinearOrAntiSens.OptionCA == 'AntiSens':
			-a
		#end if	

		#if $OptionDistance.Dist == 'Yes':
			-d $OptionDistance.distance
		#end if

		#if $OptionMinOverlap.MO == 'Yes':
			-m $OptionMinOverlap.minOverlap
		#end if

		$InvertMatch
		$ReportIntron
		$NotOverlapping
		
	</command>

	<inputs>
		<conditional name="formatType">
			<param name="FormatInputFileName1" type="select" label="Input File Format 1">
				<option value="bed">bed</option>
				<option value="gff">gff</option>
				<option value="gff2">gff2</option>
				<option value="gff3">gff3</option>
				<option value="sam">sam</option>
				<option value="gtf">gtf</option>
			</param>
			<when value="bed">
				<param name="inputFileName1" format="bed" type="data" label="Input File 1"/>
			</when>
			<when value="gff">
				<param name="inputFileName1" format="gff" type="data" label="Input File 1"/>
			</when>
			<when value="gff2">
				<param name="inputFileName1" format="gff2" type="data" label="Input File 1"/>
			</when>
			<when value="gff3">
				<param name="inputFileName1" format="gff3" type="data" label="Input File 1"/>
			</when>
			<when value="sam">
				<param name="inputFileName1" format="sam" type="data" label="Input File 1"/>
			</when>
			<when value="gtf">
				<param name="inputFileName1" format="gtf" type="data" label="Input File 1"/>
			</when>
		</conditional>

		<conditional name="formatType2">
			<param name="FormatInputFileName2" type="select" label="Input File Format 2">
				<option value="bed">bed</option>
				<option value="gff">gff</option>
				<option value="gff2">gff2</option>
				<option value="gff3">gff3</option>
				<option value="sam">sam</option>
				<option value="gtf">gtf</option>
			</param>
			<when value="bed">
				<param name="inputFileName2" format="bed" type="data" label="Input File 2"/>
			</when>
			<when value="gff">
				<param name="inputFileName2" format="gff" type="data" label="Input File 2"/>
			</when>
			<when value="gff2">
				<param name="inputFileName2" format="gff2" type="data" label="Input File 2"/>
			</when>
			<when value="gff3">
				<param name="inputFileName2" format="gff3" type="data" label="Input File 2"/>
			</when>
			<when value="sam">
				<param name="inputFileName2" format="sam" type="data" label="Input File 2"/>
			</when>
			<when value="gtf">
				<param name="inputFileName2" format="gtf" type="data" label="Input File 2"/>
			</when>
		</conditional>

		<conditional name="optionNFirstFile1">
			<param name="NFirstForFile1" type="select" label="Shrink the queries to their first N nt.">
					<option value="Yes">Yes</option>
					<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="firstNtFile1" type="integer" value="1" label="size" />
			</when>
			<when value="No">
			</when>
		</conditional>
		<conditional name="optionNFirstFile2">
			<param name="NFirstForFile2" type="select" label="Shrink the references to their first N nt.">
				<option value="Yes">Yes</option>
				<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="firstNtFile2" type="integer" value="1" label="size" />
			</when>
			<when value="No">
			</when>
		</conditional>

		<conditional name="optionNLastFile1">
			<param name="NLastForFile1" type="select" label="Shrink the queries to their last N nt.">
					<option value="Yes">Yes</option>
					<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="lastNtFile1" type="integer" value="1" label="size"/>
			</when>
			<when value="No">
			</when>
		</conditional>
		<conditional name="optionNLastFile2">
			<param name="NLastForFile2" type="select" label="Shrink the references to their last N nt.">
				<option value="Yes">Yes</option>
				<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="lastNtFile2" type="integer" value="1" label="size"/>
			</when>
			<when value="No">
			</when>
		</conditional>

		<conditional name="optionExtentionCinqFile1">
			<param name="extentionFile1" type="select" label="Extend the query features towards the 5' end">
					<option value="Yes">Yes</option>
					<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="extention51" type="integer" value="1" label="in file 1" />
			</when>
			<when value="No">
			</when>
		</conditional>

		<conditional name="optionExtentionCinqFile2">
			<param name="extentionFile2" type="select" label="Extend the reference features towards 5' end">
				<option value="Yes">Yes</option>
				<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="extention52" type="integer" value="1" label="in file 2"/>
			</when>
			<when value="No">
			</when>
		</conditional>

		<conditional name="optionExtentionTroisFile1">
			<param name="extentionFile1" type="select" label="Extend the query features towards 3' end">
					<option value="Yes">Yes</option>
					<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="extention31" type="integer" value="1" label="in file 1" />
			</when>
			<when value="No">
			</when>
		</conditional>

		<conditional name="optionExtentionTroisFile2">
			<param name="extentionFile2" type="select" label="Extend the reference features towards 3' end">
				<option value="Yes">Yes</option>
				<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="extention32" type="integer" value="1" label="in file 2" />
			</when>
			<when value="No">
			</when>
		</conditional>

		<conditional name="OptionColinearOrAntiSens">
			<param name="OptionCA" type="select" label="Report queries which are collinear/antisens w.r.t. a reference">
				<option value="Colinear">Colinear</option>
				<option value="AntiSens">AntiSens</option>
				<option value="NONE" selected="true">NONE</option>
			</param>
			<when value="Colinear">
			</when>
			<when value="AntiSens">
			</when>
			<when value="NONE">
			</when>
		</conditional>

		<conditional name="OptionDistance">
			<param name="Dist" type="select" label="Maximum Distance between two reads">
				<option value="Yes">Yes</option>
				<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="distance" type="integer" value="0"/>
			</when>
			<when value="No">
			</when>
		</conditional>

		<conditional name="OptionMinOverlap">
			<param name="MO" type="select" label="Minimum number of overlapping between two reads">
				<option value="Yes">Yes</option>
				<option value="No" selected="true">No</option>
			</param>
			<when value="Yes">
				<param name="minOverlap" type="integer" value="1"/>
			</when>
			<when value="No">
			</when>
		</conditional>
		<param name="ReportIntron" type="boolean" truevalue="-t" falsevalue="" checked="false" label="Also report queries which overlap with the introns of references, or queries such that a reference is in one of its intron"/>
		<param name="InvertMatch" type="boolean" truevalue="-x" falsevalue="" checked="false" label="Invert match: the output file will contain all query elements which do NOT overlap"/>
		<param name="NotOverlapping" type="boolean" truevalue="-O" falsevalue="" checked="false" label="Also report the query data which do not overlap, with the nbOverlaps tag set to 0."/>
	</inputs>
		
	<outputs>
		<data name="outputFileGff" format="gff3"/>
	</outputs> 
	
	<help>
This script may be the most important one. It basically compares two sets of transcripts and keeps those from the first set which overlap with the second one. The first set is considered as the query set (basically, your data) and the second one is the reference set (RefSeq data, for example).
  
It is vital to understand that it will output the elements of the first file which overlap with the elements of the second one.

Various modifiers are also available:

-Restrict query / reference set to the first nucleotide. Useful to check if the TSS of one set overlap with the other one.

-Extend query / reference set on the 5' / 3' direction. Useful to check if one set is located upstream / downstream the other one.

-Include introns in the comparison.

-Invert selection (report those which do not overlap).

-Restrict to colinear / anti-sense overlapping data.

-Keep the query data even if they do not strictly overlap with the reference data, but are located not further away than *n* nucleotide from some reference data.

-Keep the query data with are strictly included into reference data, meaning that a query transcript such that at least 1 nucleotide does not overlap with reference data will not be presented as a solution.

The mechanism of shrinking and extending is also useful to make a fine grain comparison. For example, if you want to keep those such that the TSS is overlapping the reference set, you just shrink the query set to 1 nucleotide. Now, if you want to keep those which are overlapping you data or located 2kb downstream of it, just extend the query data in the downstream direction, and you will have what you want. You can also extend in the opposite direction to get the possible transcript factor sites which are upstream.

Some option reverses the selection. Put in other words, it performs the comparison as usual, and outputs all those query data which do not overlap.
	</help>
</tool>