annotate tools/extract/liftOver_wrapper.xml @ 0:9071e359b9a3

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:37:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="liftOver1" name="Convert genome coordinates" version="1.0.3">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description> between assemblies and genomes</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 liftOver_wrapper.py
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 $input
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 "$out_file1"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 "$out_file2"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 $dbkey
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 $to_dbkey
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 #if isinstance( $input.datatype, $__app__.datatypes_registry.get_datatype_by_extension('gff').__class__) or isinstance( $input.datatype, $__app__.datatypes_registry.get_datatype_by_extension('gtf').__class__):
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 "gff"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 #else:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 "interval"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 $minMatch ${multiple.choice} ${multiple.minChainT} ${multiple.minChainQ} ${multiple.minSizeQ}
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <param format="interval,gff,gtf" name="input" type="data" label="Convert coordinates of">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <validator type="unspecified_build" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <validator type="dataset_metadata_in_file" filename="liftOver.loc" metadata_name="dbkey" metadata_column="0" message="Liftover mappings are currently not available for the specified build." />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <param name="to_dbkey" type="select" label="To">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <options from_file="liftOver.loc">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <column name="name" index="1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <column name="value" index="2"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <column name="dbkey" index="0"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <filter type="data_meta" ref="input" key="dbkey" column="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 </options>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <param name="minMatch" size="10" type="float" value="0.95" label="Minimum ratio of bases that must remap" help="Recommended values: same species = 0.95, different species = 0.10" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <conditional name="multiple">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <param name="choice" type="select" label="Allow multiple output regions?" help="Recommended values: same species = No, different species = Yes">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <option value="0" selected="true">No</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <option value="1">Yes</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <when value="0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 <param name="minSizeQ" type="hidden" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 <param name="minChainQ" type="hidden" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <param name="minChainT" type="hidden" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 <when value="1">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <param name="minSizeQ" size="10" type="integer" value="0" label="Minimum matching region size in query" help="Recommended value: set to >= 300 bases for complete transcripts"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <param name="minChainQ" size="10" type="integer" value="500" label="Minimum chain size in query"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 <param name="minChainT" size="10" type="integer" value="500" label="Minimum chain size in target"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 <data format="input" name="out_file1" label="${tool.name} on ${on_string} [ MAPPED COORDINATES ]">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 <actions>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 <action type="metadata" name="dbkey">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 <option type="from_file" name="liftOver.loc" column="1" offset="0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 <filter type="param_value" ref="to_dbkey" column="2"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 </option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 </action>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 </actions>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 </data>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 <data format="input" name="out_file2" label="${tool.name} on ${on_string} [ UNMAPPED COORDINATES ]" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 <requirement type="package">ucsc_tools</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 <param name="input" value="5.bed" dbkey="hg18" ftype="bed" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 <param name="to_dbkey" value="panTro2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 <param name="minMatch" value="0.95" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 <param name="choice" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 <output name="out_file1" file="5_liftover_mapped.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 <output name="out_file2" file="5_liftover_unmapped.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 <param name="input" value="5.bed" dbkey="hg18" ftype="bed" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 <param name="to_dbkey" value="panTro2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 <param name="minMatch" value="0.10" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 <param name="choice" value="1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 <param name="minSizeQ" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 <param name="minChainQ" value="500" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 <param name="minChainT" value="500" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 <output name="out_file1" file="5_mult_liftover_mapped.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 <output name="out_file2" file="5_mult_liftover_unmapped.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 <param name="input" value="cuffcompare_in1.gtf" dbkey="hg18" ftype="gtf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 <param name="to_dbkey" value="panTro2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 <param name="minMatch" value="0.95" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 <param name="choice" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 <output name="out_file1" file="cuffcompare_in1_liftover_mapped.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 <output name="out_file2" file="cuffcompare_in1_liftover_unmapped.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 <param name="input" value="cuffcompare_in1.gtf" dbkey="hg18" ftype="gtf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 <param name="to_dbkey" value="panTro2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 <param name="minMatch" value="0.10" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 <param name="choice" value="1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 <param name="minSizeQ" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 <param name="minChainQ" value="500" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 <param name="minChainT" value="500" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 <output name="out_file1" file="cuffcompare_in1_mult_liftover_mapped.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 <output name="out_file2" file="cuffcompare_in1_mult_liftover_unmapped.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105 .. class:: warningmark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107 Make sure that the genome build of the input dataset is specified (click the pencil icon in the history item to set it if necessary).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109 .. class:: warningmark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
111 This tool can work with interval, GFF, and GTF datasets. It requires the interval datasets to have chromosome in column 1,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
112 start co-ordinate in column 2 and end co-ordinate in column 3. BED comments
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
113 and track and browser lines will be ignored, but if other non-interval lines
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
114 are present the tool will return empty output datasets.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
115
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
116 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
117
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
118 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
119
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
120 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
121
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
122 This tool is based on the LiftOver utility and Chain track from `the UC Santa Cruz Genome Browser`__.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
123
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
124 It converts coordinates and annotations between assemblies and genomes. It produces 2 files, one containing all the mapped coordinates and the other containing the unmapped coordinates, if any.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
125
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
126 .. __: http://genome.ucsc.edu/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
127
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
128 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
129
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
130 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
131
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
132 Converting the following hg16 intervals to hg18 intervals::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
133
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
134 chrX 85170 112199 AK002185 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
135 chrX 110458 112199 AK097346 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
136 chrX 112203 121212 AK074528 0 -
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
137
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
138 will produce the following hg18 intervals::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
139
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
140 chrX 132991 160020 AK002185 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
141 chrX 158279 160020 AK097346 0 +
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
142 chrX 160024 169033 AK074528 0 -
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
143
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
144 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
145 </tool>