annotate bamtools-split.xml @ 0:71dd32fb0b0a draft

Uploaded
author devteam
date Fri, 09 Jan 2015 11:50:08 -0500
parents
children 4555f451dd79
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
1 <tool id="bamSplit" name="Split" version="0.0.1" force_history_refresh="True">
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
2 <description>BAM datasets on variety of attributes</description>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
3 <requirements>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="2.3.0_2d7685d2ae">bamtools</requirement>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
5 </requirements>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
6 <command>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
7
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
8 echo "BAM" > $report &amp;&amp;
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
9
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
10 #for $bam_count, $input_bam in enumerate( $input_bams ):
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
11 ln -s "${input_bam.input_bam}" "localbam_${bam_count}.bam" &amp;&amp;
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
12 ln -s "${input_bam.input_bam.metadata.bam_index}" "localbam_${bam_count}.bam.bai" &amp;&amp;
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
13 #end for
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
14
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
15 bamtools
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
16 split
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
17
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
18 #if str ( $analysis_type.analysis_type_selector ) == "-tag" :
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
19
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
20 ${analysis_type.analysis_type_selector} "${analysis_type.tag_name}"
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
21
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
22 #else
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
23
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
24 ${analysis_type.analysis_type_selector}
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
25
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
26 #end if
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
27
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
28 -stub split_bam
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
29
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
30 #for $bam_count, $input_bam in enumerate( $input_bams ):
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
31 -in "localbam_${bam_count}.bam"
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
32 #end for
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
33
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
34 </command>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
35
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
36 <inputs>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
37 <repeat name="input_bams" title="BAM dataset(s) to filter" min="1">
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
38 <param name="input_bam" type="data" format="bam" label="BAM dataset" />
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
39 </repeat>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
40 <conditional name="analysis_type">
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
41 <param name="analysis_type_selector" type="select" label="Split BAM dataset(s) by" help="See help below for explanation of each option">
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
42 <option value="-mapped">Mapping status (-mapped)</option>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
43 <option value="-paired">Pairing status (-paired)</option>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
44 <option value="-reference">Reference name (-reference)</option>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
45 <option value="-tag">Specific tag (-tag)</option>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
46 </param>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
47 <when value="-tag">
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
48 <param name="tag_name" type="text" value="NM" label="Enter tag name here" help="For example, to split on NM tag enter &quot;NM&quot;"/>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
49 </when>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
50 </conditional>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
51 </inputs>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
52
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
53 <outputs>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
54 <data format="txt" name="report" label="BAMSplitter Run" hidden="true">
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
55 <discover_datasets pattern="split_bam\.(?P&lt;designation&gt;.+)\.bam" ext="bam" visible="true"/>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
56 </data>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
57 </outputs>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
58 <tests>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
59 <test>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
60 <param name="input_bam" ftype="bam" value="bamtools-input1.bam"/>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
61 <param name="analysis_type_selector" value="-mapped"/>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
62 <output name="report">
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
63 <assert_contents>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
64 <has_line line="BAM" />
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
65 </assert_contents>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
66 <discovered_dataset designation="MAPPED" file="bamtools-split-test1.bam" ftype="bam"/>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
67 </output>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
68
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
69 </test>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
70 </tests>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
71 <help>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
72 **What is does**
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
73
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
74 BAMTools split is a utility for splitting BAM files. It is based on BAMtools suite of tools by Derek Barnett (https://github.com/pezmaster31/bamtools).
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
75
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
76 -----
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
77
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
78 .. class:: warningmark
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
79
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
80 **DANGER: Multiple Outputs**
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
81
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
82 As described below, splitting a BAM dataset(s) on reference name or a tag value can produce very large numbers of outputs. Read below and know what you are doing.
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
83
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
84 -----
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
85
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
86 **How it works**
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
87
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
88 The following options can be specified via "**Split BAM dataset(s) by**" dropdown::
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
89
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
90 Mapping status (-mapped) split mapped/unmapped and generate two output files
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
91 named (MAPPED) and (UNMAPPED) containing mapped and unmapped
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
92 reads, respectively.
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
93
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
94 Pairing status (-paired) split single-end/paired-end alignments and generate two output files
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
95 named (SINGLE_END) and (PAIRED_END) containing paired and unpaired
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
96 reads, respectively.
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
97
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
98 Reference name (-reference) split alignments by reference name. In cases of unfinished genomes with
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
99 very large number of reference sequences (scaffolds) it can generate
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
100 thousands (if not millions) of output datasets.
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
101
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
102 Specific tag (-tag) split alignments based on all values of TAG encountered. Choosing this
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
103 option from the menu will allow you to enter the tag name. As was the
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
104 case with the reference splitting above, this option can produce very
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
105 large number of outputs if a tag has a large number of unique values.
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
106
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
107 -----
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
108
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
109 .. class:: infomark
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
110
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
111 **More information**
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
112
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
113 Additional information about BAMtools can be found at https://github.com/pezmaster31/bamtools/wiki
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
114
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
115 </help>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
116 <citations>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
117 <citation type="doi">10.1093/bioinformatics/btr174</citation>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
118 </citations>
71dd32fb0b0a Uploaded
devteam
parents:
diff changeset
119 </tool>