annotate extract_genomic_dna.xml @ 2:cc1879e0b0ae draft

Uploaded
author greg
date Thu, 14 Jan 2016 09:31:08 -0500
parents 311febbd33d6
children 3d40351fc9ac
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
1 <tool id="Extract genomic DNA 1" name="Extract Genomic DNA" version="3.0.0">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
2 <description>using coordinates from assembled/unassembled genomes</description>
1
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
3 <requirements>
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
4 <requirement type="package" version="35x1">faToTwoBit</requirement>
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
5 </requirements>
0
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
6 <command>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
7 <![CDATA[
2
cc1879e0b0ae Uploaded
greg
parents: 1
diff changeset
8 #set input_format = $input.ext
1
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
9 #set genome = $input.metadata.dbkey
0
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
10 #set datatype = $input.datatype
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
11 mkdir -p output_dir &&
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
12 python $__tool_directory__/extract_genomic_dna.py
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
13 --input_format $input_format
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
14 --input "$input"
1
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
15 --genome "$genome"
0
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
16 #if str($input_format) == "gff":
1
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
17 --interpret_features $interpret_features
0
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
18 #end if
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
19 #if isinstance($datatype, $__app__.datatypes_registry.get_datatype_by_extension('gff').__class__):
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
20 --columns "1,4,5,7"
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
21 #else:
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
22 --columns "${input.metadata.chromCol},${input.metadata.startCol},${input.metadata.endCol},${input.metadata.strandCol},${input.metadata.nameCol}"
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
23 #end if
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
24 --reference_genome_source $reference_genome_cond.reference_genome_source
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
25 #if str($reference_genome_cond.reference_genome_source) == "cached"
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
26 --reference_genome $reference_genome_cond.reference_genome.fields.path
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
27 #else:
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
28 --reference_genome $reference_genome_cond.reference_genome
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
29 #end if
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
30 --output_format $output_format
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
31 --output $output
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
32 ]]>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
33 </command>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
34 <inputs>
1
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
35 <param name="input" type="data" format="gff,interval" label="Fetch sequences for intervals in" help="Supported formats are gff, interval">
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
36 <validator type="unspecified_build" />
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
37 </param>
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
38 <param name="interpret_features" type="select" label="Interpret features when possible" help="Applicable only when input dataset format is gff">
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
39 <option value="yes">Yes</option>
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
40 <option value="no">No</option>
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
41 </param>
0
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
42 <conditional name="reference_genome_cond">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
43 <param name="reference_genome_source" type="select" label="Choose the source for the reference genome">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
44 <option value="cached">locally cached</option>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
45 <option value="history">from history</option>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
46 </param>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
47 <when value="cached">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
48 <param name="reference_genome" type="select" label="Using reference genome">
1
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
49 <options from_data_table="twobit">
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
50 <filter type="data_meta" key="dbkey" ref="input" column="0"/>
0
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
51 </options>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
52 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
53 </param>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
54 </when>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
55 <when value="history">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
56 <param name="reference_genome" type="data" format="fasta" label="Using reference genome">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
57 <options>
1
311febbd33d6 Uploaded
greg
parents: 0
diff changeset
58 <filter type="data_meta" key="dbkey" ref="input"/>
0
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
59 </options>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
60 <validator type="no_options" message="The current history does not include a fasta dataset with the build associated with the selected input file"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
61 </param>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
62 </when>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
63 </conditional>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
64 <param name="output_format" type="select" label="Select output format">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
65 <option value="fasta" selected="True">fasta</option>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
66 <option value="interval">interval</option>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
67 </param>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
68 </inputs>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
69 <outputs>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
70 <data name="output" format="gff">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
71 <change_format>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
72 <when output_format="interval" format="interval" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
73 </change_format>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
74 </data>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
75 </outputs>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
76 <tests>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
77 <test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
78 <param name="input" value="1.bed" dbkey="hg17" ftype="bed" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
79 <param name="interpret_features" value="yes"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
80 <param name="index_source" value="cached"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
81 <param name="out_format" value="fasta"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
82 <output name="out_file1">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
83 <assert_contents>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
84 <!-- First few lines... -->
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
85 <has_text text=">hg17_chr1_147962192_147962580_- CCDS989.1_cds_0_0_chr1_147962193_r" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
86 <has_text text="ACTTGATCCTGCTCCCTCGGTGTCTGCATTGACTCCTCATGCTGGGACTG" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
87 <has_text text="GACCCGTCAACCCCCCTGCTCGCTGCTCACGTACCTTCATCACTTTTAGT" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
88 <has_text text="GATGATGCAACTTTCGAGGAATGGTTCCCCCAAGGGCGGCCCCCAAAAGT" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
89 <!-- Last few lines... -->
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
90 <has_text text="GCTGTGGCACAGAACATGGACTCTGTGTTTAAGGAGCTCTTGGGAAAGAC" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
91 <has_text text="CTCTGTCCGCCAGGGCCTTGGGCCAGCATCTACCACCTCTCCCAGTCCTG" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
92 <has_text text="GGCCCCGAAGCCCAAAGGCCCCGCCCAGCAGCCGCCTGGGCAGGAACAAA" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
93 <has_text text="GGCTTCTCCCGGGGCCCTGGGGCCCCAGCCTCACCCTCAGCTTCCCACCC" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
94 <has_text text="CCAGGGCCTAGACACGACCCCCAAGCCACACTGA" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
95 </assert_contents>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
96 </output>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
97 </test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
98 <test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
99 <param name="input" value="droPer1.bed" dbkey="droPer1" ftype="bed" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
100 <param name="interpret_features" value="yes"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
101 <param name="index_source" value="cached"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
102 <param name="out_format" value="fasta"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
103 <output name="out_file1" file="extract_genomic_dna_out2.fasta" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
104 </test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
105 <test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
106 <param name="input" value="1.bed" dbkey="hg17" ftype="bed" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
107 <param name="interpret_features" value="yes"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
108 <param name="index_source" value="cached"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
109 <param name="out_format" value="interval"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
110 <output name="out_file1" file="extract_genomic_dna_out3.interval" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
111 </test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
112 <!-- Test GFF file support. -->
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
113 <test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
114 <param name="input" value="gff_filter_by_attribute_out1.gff" dbkey="mm9" ftype="gff" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
115 <param name="interpret_features" value="no"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
116 <param name="index_source" value="cached"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
117 <param name="out_format" value="interval"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
118 <output name="out_file1" file="extract_genomic_dna_out4.gff" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
119 </test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
120 <test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
121 <param name="input" value="gff_filter_by_attribute_out1.gff" dbkey="mm9" ftype="gff" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
122 <param name="interpret_features" value="no"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
123 <param name="out_format" value="fasta"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
124 <param name="index_source" value="cached"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
125 <output name="out_file1" file="extract_genomic_dna_out5.fasta" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
126 </test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
127 <!-- Test custom sequences support and GFF feature interpretation. -->
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
128 <test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
129 <param name="input" value="cufflinks_out1.gtf" dbkey="mm9" ftype="gff" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
130 <param name="interpret_features" value="no"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
131 <param name="index_source" value="history"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
132 <param name="ref_file" value="tophat_in1.fasta"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
133 <param name="out_format" value="fasta"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
134 <output name="out_file1" file="extract_genomic_dna_out6.fasta" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
135 </test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
136 <test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
137 <param name="input" value="cufflinks_out1.gtf" dbkey="mm9" ftype="gff" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
138 <param name="interpret_features" value="yes"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
139 <param name="index_source" value="history"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
140 <param name="ref_file" value="tophat_in1.fasta"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
141 <param name="out_format" value="fasta"/>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
142 <output name="out_file1" file="extract_genomic_dna_out7.fasta" />
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
143 </test>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
144 </tests>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
145 <help>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
146
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
147 .. class:: warningmark
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
148
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
149 The following will cause a line from the input dataset to be skipped and a warning generated.
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
150
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
151 - Sequences that fall outside of the range of a line's start and end coordinates.
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
152 - Chromosome start or end coordinates that are invalid for the specified build.
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
153
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
154 -----
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
155
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
156 **What it does**
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
157
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
158 This tool uses coordinate, strand, and build information to fetch genomic DNA from gff data, producing fasta data.
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
159
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
160 -----
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
161
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
162 **Example**
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
163
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
164 If the input dataset is::
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
165
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
166 chr7 127475281 127475310 NM_000230 0 +
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
167 chr7 127485994 127486166 NM_000230 0 +
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
168 chr7 127486011 127486166 D49487 0 +
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
169
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
170 Extracting sequences returns::
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
171
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
172 &gt;hg17_chr7_127475281_127475310_+ NM_000230
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
173 GTAGGAATCGCAGCGCCAGCGGTTGCAAG
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
174 &gt;hg17_chr7_127485994_127486166_+ NM_000230
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
175 GCCCAAGAAGCCCATCCTGGGAAGGAAAATGCATTGGGGAACCCTGTGCG
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
176 GATTCTTGTGGCTTTGGCCCTATCTTTTCTATGTCCAAGCTGTGCCCATC
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
177 CAAAAAGTCCAAGATGACACCAAAACCCTCATCAAGACAATTGTCACCAG
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
178 GATCAATGACATTTCACACACG
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
179 &gt;hg17_chr7_127486011_127486166_+ D49487
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
180 TGGGAAGGAAAATGCATTGGGGAACCCTGTGCGGATTCTTGTGGCTTTGG
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
181 CCCTATCTTTTCTATGTCCAAGCTGTGCCCATCCAAAAAGTCCAAGATGA
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
182 CACCAAAACCCTCATCAAGACAATTGTCACCAGGATCAATGACATTTCAC
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
183 ACACG
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
184
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
185 </help>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
186 <citations>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
187 <citation type="bibtex">
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
188 @unpublished{None,
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
189 author = {},
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
190 title = {None},
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
191 year = {None},
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
192 eprint = {None},
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
193 url = {http://www.bx.psu.edu/~anton/labSite/}
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
194 }</citation>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
195 </citations>
cff5b7c9be55 Uploaded
greg
parents:
diff changeset
196 </tool>