annotate bamtools.xml @ 2:ea3fc1adee75 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
author devteam
date Wed, 11 Nov 2015 12:33:26 -0500
parents 76b2f1eee508
children 04866f817daa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
1 <?xml version="1.0"?>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
2 <tool id="bamtools" name="Convert, Merge, Randomize" version="0.0.2">
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
3 <description>BAM datasets and perform other transformations</description>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
4 <requirements>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
5 <requirement type="package" version="2.3.0_2d7685d2ae">bamtools</requirement>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
6 <requirement type="package" version="0.1.18">samtools</requirement>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
7 </requirements>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
8
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
9 <command>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
10 ##set up input files
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
11
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
12 #for $bam_count, $input_bam in enumerate( $input_bams ):
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
13 ln -s "${input_bam}" "localbam_${bam_count}.bam" &amp;&amp;
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
14 ln -s "${input_bam.metadata.bam_index}" "localbam_${bam_count}.bam.bai" &amp;&amp;
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
15 #end for
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
16
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
17 #if str( $analysis_type.analysis_type_selector ) == "convert":
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
18 #if str( $analysis_type.format_type.format_type_selector ) == "pileup":
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
19 #set $reference_fasta_filename = "localref.fa"
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
20 #if str( $analysis_type.format_type.reference_source.reference_source_selector ) == "history":
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
21 ln -s "${analysis_type.format_type.reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
22 samtools faidx "${reference_fasta_filename}" 2&gt;&amp;1 || echo "Error running samtools faidx for bamtools convert" &gt;&amp;2 &amp;&amp;
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
23 #else:
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
24 #set $reference_fasta_filename = str( $analysis_type.format_type.reference_source.ref_file.fields.path )
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
25 #end if
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
26 #end if
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
27 #end if
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
28
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
29 ##finished setting up inputs
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
30
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
31 ##start bamtools commandline
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
32
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
33 bamtools
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
34
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
35 #if str( $analysis_type.analysis_type_selector ) == "convert":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
36
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
37 convert
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
38
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
39 -format ${analysis_type.format_type.format_type_selector}
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
40
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
41 #if str( $analysis_type.format_type.format_type_selector ) == "pileup":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
42
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
43 ${analysis_type.format_type.mapqual}
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
44 -fasta "${reference_fasta_filename}"
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
45
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
46 #elif str( $analysis_type.format_type.format_type_selector ) == "sam":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
47
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
48 ${analysis_type.format_type.noheader}
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
49
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
50 #end if
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
51
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
52 -out $out_file1
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
53
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
54 #elif str( $analysis_type.analysis_type_selector ) == "count":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
55
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
56 count
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
57 > $out_file1
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
58
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
59 #elif str( $analysis_type.analysis_type_selector ) == "coverage":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
60
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
61 coverage
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
62 -out $out_file1
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
63
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
64 #elif str( $analysis_type.analysis_type_selector ) == "header":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
65
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
66 header
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
67 > $out_file1
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
68
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
69 #elif str( $analysis_type.analysis_type_selector ) == "merge":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
70
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
71 merge
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
72 -out $out_file1
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
73
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
74 #elif str( $analysis_type.analysis_type_selector ) == "random":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
75
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
76 random
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
77 -n ${analysis_type.count}
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
78 -seed ${analysis_type.seed}
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
79 -out $out_file1
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
80
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
81 #elif str( $analysis_type.analysis_type_selector ) == "revert":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
82
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
83 revert
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
84 ${analysis_type.keepDuplicate}
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
85 ${analysis_type.keepQualities}
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
86 -out $out_file1
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
87
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
88 #elif str( $analysis_type.analysis_type_selector ) == "sort":
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
89
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
90 sort
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
91 ${analysis_type.byname}
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
92 -out $out_file1
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
93
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
94 #end if
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
95
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
96 #for $bam_count, $input_bam in enumerate( $input_bams ):
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
97 -in "localbam_${bam_count}.bam"
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
98 #end for
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
99
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
100
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
101 </command>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
102 <inputs>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
103
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
104 <param name="input_bams" type="data" format="bam" label="BAM dataset(s) to filter" min="1" multiple="True"/>
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
105
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
106 <conditional name="analysis_type">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
107 <param name="analysis_type_selector" type="select" label="Select BAM manipulation" help="See help below for detailed description of each tool">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
108 <option value="convert">Convert</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
109 <option value="count">Count</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
110 <option value="coverage">Coverage</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
111 <option value="header">Header</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
112 <option value="merge">Merge</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
113 <option value="random">Random</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
114 <option value="revert">Revert</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
115 <!-- The sort option below is commented out as BAM files in Galaxy are reference sorted by dafault. -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
116 <!-- Allowing users for sort files may break donstream functionality. -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
117 <!-- To enable sort option simply uncomment the line below: -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
118 <!-- <option value="sort">Sort</option> -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
119 </param>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
120 <when value="convert">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
121 <conditional name="format_type">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
122 <param name="format_type_selector" type="select" help="Select what to convert your BAM to">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
123 <option value="bed">BED</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
124 <option value="fasta">FASTA</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
125 <option value="fastq">FASTQ</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
126 <option value="json">JSON</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
127 <option value="pileup">Pileup</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
128 <option value="sam">SAM</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
129 <option value="yaml">YAML</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
130 </param>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
131 <when value="pileup">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
132 <conditional name="reference_source">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
133 <param name="reference_source_selector" type="select" label="Choose the source for the reference list">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
134 <option value="cached">Locally cached</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
135 <option value="history">History</option>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
136 </param>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
137 <when value="cached">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
138 <param name="ref_file" type="select" label="Using reference genome">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
139 <options from_data_table="sam_fa_indexes">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
140 <!--<filter type="data_meta" key="dbkey" ref="input_bam" column="value"/>-->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
141 </options>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
142 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
143 </param>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
144 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
145 <when value="history"> <!-- FIX ME!!!! -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
146 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
147 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
148 </conditional>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
149 <param name="mapqual" type="boolean" truevalue="-mapqual" falsevalue="" label="Print quality scores?" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
150 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
151 <when value="sam">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
152 <param name="noheader" type="boolean" truevalue="-noheader" falsevalue="" label="Do not print header" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
153 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
154 </conditional>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
155 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
156 <when value="count">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
157 <!-- Nothing to be done with count -> just count alignments in the input bam(s) -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
158 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
159 <when value="coverage">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
160 <!-- Nothing to be done with count -> just count alignments in the input bam(s) -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
161 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
162 <when value="header">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
163 <!-- Nothing to be done with count -> just count alignments in the input bam(s) -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
164 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
165 <when value="merge">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
166 <!-- Nothing to be done with count -> just count alignments in the input bam(s) -->
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
167 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
168 <when value="random">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
169 <param name="count" type="integer" value="10000" label="Number of random alignments to grab" help="No duplicate checking is perfomed" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
170 <param name="seed" type="integer" value="1024" label="Random number generator seed" help="Use the same seed for reproducible results" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
171 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
172 <when value="revert">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
173 <param name="keepDuplicate" type="boolean" truevalue="-keepDuplicate" falsevalue="" label="Keep duplicates marked" help="Do not remove duplicate marks" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
174 <param name="keepQualities" type="boolean" truevalue="-keepQualities" falsevalue="" label="Keep base qualities" help="Do not replace qualities with contect of OQ tag" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
175 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
176 <when value="sort">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
177 <param name="byname" type="boolean" truevalue="-byname" falsevalue="" label="Sort by name" help="Checked: sort by name; Unchecked: sort by coordinate"/>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
178 </when>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
179 </conditional>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
180
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
181 </inputs>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
182 <outputs>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
183 <data format="txt" name="out_file1">
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
184 <change_format>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
185 <when input="analysis_type.format_type.format_type_selector" value="bed" format="bed" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
186 <when input="analysis_type.format_type.format_type_selector" value="fasta" format="fasta" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
187 <when input="analysis_type.format_type.format_type_selector" value="fastq" format="fastq" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
188 <when input="analysis_type.format_type.format_type_selector" value="sam" format="sam" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
189 <when input="analysis_type.format_type.format_type_selector" value="pileup" format="pileup" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
190 <when input="analysis_type.analysis_type_selector" value="coverage" format="tabular" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
191 <when input="analysis_type.analysis_type_selector" value="merge" format="bam" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
192 <when input="analysis_type.analysis_type_selector" value="random" format="bam" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
193 <when input="analysis_type.analysis_type_selector" value="revert" format="bam" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
194 <when input="analysis_type.analysis_type_selector" value="sort" format="bam" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
195 </change_format>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
196 </data>
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
197 </outputs>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
198 <tests>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
199 <test>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
200 <param name="input_bams" ftype="bam" value="bamtools-input1.bam"/>
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
201 <param name="analysis_type_selector" value="convert"/>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
202 <param name="format_type_selector" value="pileup"/>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
203 <param name="reference_source_selector" value="history" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
204 <param name="mapqual" value="true" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
205 <param name="ref_file" ftype="fasta" value="bamtools-fasta.fa"/>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
206 <output name="output_bam" file="bamtools-convert-pileup.pu" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
207 </test>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
208 <test>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
209 <param name="input_bams" ftype="bam" value="bamtools-input1.bam"/>
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
210 <param name="analysis_type_selector" value="count"/>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
211 <output name="output_bam" file="bamtools-count.tab" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
212 </test>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
213 <test>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
214 <param name="input_bams" ftype="bam" value="bamtools-input1.bam"/>
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
215 <param name="analysis_type_selector" value="coverage"/>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
216 <output name="output_bam" file="bamtools-coverage.tab" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
217 </test>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
218 <test>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
219 <param name="input_bams" ftype="bam" value="bamtools-input1.bam"/>
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
220 <param name="analysis_type_selector" value="header"/>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
221 <output name="output_bam" file="bamtools-header.txt" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
222 </test>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
223 </tests>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
224
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
225 <stdio>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
226 <exit_code range="1:" />
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
227 </stdio>
2
ea3fc1adee75 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/bamtools/bamtools commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
228
0
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
229 <help>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
230
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
231 **What is does**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
232
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
233 BAMTools is a collection of utilities for manipulation on BAM files. It is based on BAMtools suite of tools by Derek Barnett (https://github.com/pezmaster31/bamtools).
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
234 This Galaxy implementation of BAMTools utilities includes seven utilities - Convert, Count, Coverage, Header, Merge, Random, and Revert - decsribed in detail below.
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
235
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
236 -----
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
237
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
238 **Convert**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
239
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
240 Converts BAM dataset(s) into BED, FASTA, FASTQ, JSON, Pileup, SAM, or YAML formats. Note that the conversion to the pileup format requires providing a reference sequence either
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
241 cashed at this Galaxy instance, or provided by you as a FASTA dataset from History.
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
242
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
243 -----
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
244
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
245 **Count**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
246
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
247 Counts a number of alignments in a BAM dataset(s).
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
248
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
249 -----
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
250
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
251 **Coverage**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
252
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
253 Prints per-base coverage for a BAM dataset.
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
254
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
255 -----
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
256
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
257 **Header**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
258
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
259 Prints header from a BAM dataset(s).
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
260
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
261 ------
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
262
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
263 **Merge**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
264
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
265 Merges multiple BAM datasets into a single one. Obviously, you need to select multiple BAMs as input, which is done by pressing the "**Add new BAM dataset(s) to filter**" button.
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
266
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
267 ------
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
268
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
269 **Random**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
270
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
271 Grabs a specified number of random lines from BAM dataset(s).
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
272
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
273 ------
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
274
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
275 **Revert**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
276
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
277 Removes duplicate marks and restores original (non-recalibrated) base qualities.
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
278
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
279 -----
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
280
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
281 .. class:: infomark
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
282
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
283 **More information**
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
284
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
285 Additional information about BAMtools can be found at https://github.com/pezmaster31/bamtools/wiki
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
286
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
287 </help>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
288 <citations>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
289 <citation type="doi">10.1093/bioinformatics/btr174</citation>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
290 </citations>
76b2f1eee508 Uploaded
devteam
parents:
diff changeset
291 </tool>