Mercurial > repos > devteam > bamtools_split

annotate bamtools-split.xml @ 4:64ed37303c15 draft default tip

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