annotate bigbed_to_fa.xml @ 0:512ed6da2367 draft default tip

planemo upload
author yating-l
date Wed, 17 May 2017 16:49:32 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
1 <?xml version="1.0"?>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
2 <tool id="bigbed_to_fa" name="bigBedToFa" version="1.0">
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
3 <description>Retrieve sequences associated with bigBed features</description>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
4
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
5 <macros>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
6 <import>ucsc_macros.xml</import>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
7 </macros>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
8
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
9 <expand macro="requirements_twobit">
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
10 <requirement type="package" version="340">ucsc_bigbed</requirement>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
11 </expand>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
12
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
13 <command detect_errors="exit_code">
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
14 <![CDATA[
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
15 #set no_mask = ""
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
16 #if str($masking_option) == "upper":
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
17 #set no_mask = "-noMask"
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
18 #end if
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
19
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
20 ${__tool_directory__}/bigbed_to_standard_bed.pl -i "${bigbed_input}" |
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
21 twoBitToFa ${no_mask} -bed=stdin "${twobit_input}" stdout
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
22
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
23 ## Add extra option to change soft masked bases to N's
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
24 #if str($masking_option) == "hard":
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
25 | awk '{ if (/^>/) { print } else { gsub(/[acgt]/, "N"); print } }'
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
26 #end if
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
27
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
28 > "${fasta_output}"
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
29 ]]>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
30 </command>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
31 <inputs>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
32 <param name="twobit_input" type="data" format="twobit" label="twoBit input file" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
33
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
34 <param name="bigbed_input" type="data" format="bigbed" label="bigBed input file" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
35
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
36 <param name="masking_option" type="select"
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
37 label="Repeat masking option"
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
38 help="Specify how repeats within the twoBit file should be represented">
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
39
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
40 <option value="upper">Show repeats in uppercase (no masking)</option>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
41
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
42 <option value="lower" selected="true">Show repeats in lowercase (soft masking)</option>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
43
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
44 <option value="hard">Show repeats as N's (hard masking)</option>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
45 </param>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
46
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
47 </inputs>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
48 <outputs>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
49 <data name="fasta_output" format="fasta" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
50 </outputs>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
51 <tests>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
52 <test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
53 <!-- Test bigBedToFa with bed4 and default (soft) masking -->
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
54 <param name="twobit_input" value="contigs.out.2bit" ftype="twobit" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
55 <param name="bigbed_input" value="contigs.trf_4.bb" ftype="bigbed" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
56 <output name="fasta_output" file="contigs.trf_4.soft.fa" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
57 </test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
58 <test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
59 <!-- Test bigBedToFa with bed4 and no masking -->
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
60 <param name="twobit_input" value="contigs.out.2bit" ftype="twobit" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
61 <param name="bigbed_input" value="contigs.trf_4.bb" ftype="bigbed" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
62 <param name="masking_option" value="upper" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
63 <output name="fasta_output" file="contigs.trf_4.nomask.fa" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
64 </test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
65 <test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
66 <!-- Test bigBedToFa with bed4 and hard masking -->
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
67 <param name="twobit_input" value="contigs.out.2bit" ftype="twobit" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
68 <param name="bigbed_input" value="contigs.trf_4.bb" ftype="bigbed" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
69 <param name="masking_option" value="hard" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
70 <output name="fasta_output" file="contigs.trf_4.hard.fa" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
71 </test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
72 <test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
73 <!-- Test bigBedToFa with bed4+12 with default masking -->
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
74 <param name="twobit_input" value="contigs.out.2bit" ftype="twobit" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
75 <param name="bigbed_input" value="contigs.trf_4_12.bb" ftype="bigbed" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
76 <output name="fasta_output" file="contigs.trf_4_12.fa" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
77 </test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
78 <test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
79 <!-- Test bigBedToFa with bed6+2 with default masking -->
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
80 <param name="twobit_input" value="contigs.out.2bit" ftype="twobit" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
81 <param name="bigbed_input" value="contigs.models_6_2.bb" ftype="bigbed" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
82 <output name="fasta_output" file="contigs.models_6_2.fa" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
83 </test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
84 <test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
85 <!-- Test bigBedToFa with bed12+2 with default masking -->
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
86 <param name="twobit_input" value="contigs.out.2bit" ftype="twobit" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
87 <param name="bigbed_input" value="contigs.models_12_2.bb" ftype="bigbed" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
88 <output name="fasta_output" file="contigs.models_12_2.fa" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
89 </test>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
90 </tests>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
91 <help>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
92 <![CDATA[
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
93 **What it does**
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
94
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
95 bigBedToFa retrieves sequences associated with the features in a
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
96 `bigBed <https://genome.ucsc.edu/goldenpath/help/bigBed.html>`_ file
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
97 from a `twoBit Sequence Archive <https://genome.ucsc.edu/goldenpath/help/twoBit.html>`_.
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
98
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
99 .. class:: infomark
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
100
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
101 **Extracted sequences:**
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
102
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
103 For files with `12 standard BED columns <https://genome.ucsc.edu/FAQ/FAQformat.html#format1>`_,
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
104 this program will concatenate the sequences associated with each block (e.g., exons), and
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
105 exclude the sequences between adjacent blocks (e.g., introns).
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
106
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
107 ]]></help>
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
108
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
109 <expand macro="citations" />
512ed6da2367 planemo upload
yating-l
parents:
diff changeset
110 </tool>