annotate bwtool.xml @ 2:536ed601756f draft default tip

Uploaded
author pavanvidem
date Wed, 20 May 2015 13:16:13 -0400
parents 150d543a04ca
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
1 <tool id="bwtool-lift" name="bwtool-lift" version="1.0">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
2 <description>Project data base-by-base into a new assembly using a liftOver chain file from UCSC</description>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
3 <requirements>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
4 <requirement type="package">bwtool</requirement>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
5 </requirements>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
6 <command>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
7 <![CDATA[
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
8 bwtool lift $in_bw $to_dbkey $out_bw
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
9 #if $unlifted.saveregions == "yes":
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
10 -unlifted=$unlifted.unlifted_file
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
11 #end if
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
12 #if $outwig.usetype == "yes":
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
13 -wigtype=$outwig.wigtype
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
14 #end if
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
15 $wigonly
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
16 #if $regions.useregions == "yes":
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
17 -regions=$regions.regionsbed
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
18 #end if
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
19 $condense
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
20 -decimals=$decimals
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
21 #if $fill.fillmissing == "yes":
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
22 -fill=$fill.fillvalue
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
23 #end if
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
24 -pseudo=$pseudo
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
25 ]]>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
26 </command>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
27 <inputs>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
28 <param name="in_bw" type="data" format="bigwig" label="Convert coordinates of">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
29 <param name="to_dbkey" type="select" label="To">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
30 <options from_file="liftOver.loc">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
31 <column name="name" index="1"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
32 <column name="value" index="2"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
33 <column name="dbkey" index="0"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
34 <filter type="data_meta" ref="input" key="dbkey" column="0" />
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
35 </options>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
36 </param>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
37 <conditional name="outwig">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
38 <param name="usetype" type="select" label="use specific regions?" help="">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
39 <option value="no">no</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
40 <option value="yes">yes</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
41 </param>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
42 <when value="no"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
43 <when value="yes">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
44 <param name="wigtype" type="select" label="Output type">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
45 <option value="bg">bedGraph</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
46 <option value="fix">fixedStep wig</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
47 <option value="var">variableStep wig</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
48 </param>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
49 </when>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
50 </conditional>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
51 <param name="wigonly" type="boolean" truevalue="-wig-only" falsevalue="" checked="false"
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
52 label="wig-only"
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
53 help="for bigWig-creating programs, make a wig instead" />
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
54 <conditional name="regions">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
55 <param name="useregions" type="select" label="use specific regions?" help="">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
56 <option value="no">no</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
57 <option value="yes">yes</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
58 </param>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
59 <when value="no"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
60 <when value="yes">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
61 <param name="regionsbed" type="data" format="bed" label="regions BED file"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
62 </when>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
63 </conditional>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
64 <param name="regionsbed" type="data" format="bed" label="use specific regions"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
65 <param name="condense" type="boolean" truevalue="-condense" falsevalue="" checked="true"
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
66 label="condense"
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
67 help="condense output, particularly bedGraphs" />
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
68 <conditional name="fillmissing">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
69 <param name="fill" type="select" label="use specific regions?" help="">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
70 <option value="no">no</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
71 <option value="yes">yes</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
72 </param>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
73 <when value="no"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
74 <when value="yes">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
75 <param name="fillvalue" size="10" type="text" label="some programs allow filling missing parts of the bigWig with a specified value prior to using data"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
76 </when>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
77 </conditional>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
78 <param name="fill" size="10" type="text" label="some programs allow filling missing parts of the bigWig with a specified value prior to using data"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
79 <param name="pseudo" size="10" value="0" type="text" label="add a pseudo-count at every value"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
80 </inputs>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
81 <outputs>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
82 <data format="txt" name="out_bw" label="${tool.name} result file on ${on_string}"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
83 <conditional name="unlifted">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
84 <param name="saveregions" type="select" label="Save all the regions from the input that are not lifted?" help="">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
85 <option value="no">no</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
86 <option value="yes">yes</option>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
87 </param>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
88 <when value="no"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
89 <when value="yes">
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
90 <param name="unlifted_file" label="Unlifted regions on ${on_string}"/>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
91 </when>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
92 </conditional>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
93 </outputs>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
94 <help>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
95 <![CDATA[
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
96
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
97 .. class:: infomark
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
98
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
99 **What it does**
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
100
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
101 The lift program does quite a useful thing when one needs to use data generated for an old genome assembly and doesn't necessarily have the time or the means to go through the steps of generating the equivalent data for a newer genome assembly. Lifting data is the process of converting the coordinates where that data lies, from one assembly to another through sequence alignment data. UCSC creates special alignment files for this purpose called liftOver chains and makes them available on their download page. Lifting is not a perfect process, but if the regions lifted are relatively short, usually only a small percent are not mappable through the chain. In the case of bigWig data, each base is mapped one by one, and is only mapped to the destination genome if it maps to a new locus unambiguously.
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
102
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
103
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
104 **Input**
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
105
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
106 Bigwig file
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
107
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
108
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
109 **References**
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
110
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
111
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
112 ]]>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
113 </help>
150d543a04ca Uploaded
pavanvidem
parents:
diff changeset
114 </tool>