annotate bamtools-split-paired.xml @ 1:59f09c61031c draft default tip

Deleted selected files
author jjohnson
date Mon, 15 May 2017 16:44:31 -0400
parents 8c17ddca0eee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
1 <tool id="bamSplitPaired" name="Split BAM by Paired/Single End" version="2.4.0">
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
2 <description></description>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
3 <requirements>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
4 <requirement type="package" version="2.4.0">bamtools</requirement>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
5 </requirements>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
6 <command>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
7 <![CDATA[
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
8 ln -s '${input_bam}' 'localbam.bam' &&
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
9 ln -s '${input_bam.metadata.bam_index}' 'localbam.bam.bai' &&
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
10 bamtools split -paired
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
11 -in localbam.bam
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
12 -stub split_bam
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
13 ]]>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
14 </command>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
15 <inputs>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
16 <param name="input_bam" type="data" format="bam" label="BAM dataset to split by single_end/paired_end"/>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
17 </inputs>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
18 <outputs>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
19 <data format="bam" name="single" label="${input_bam.name} mapped" from_work_dir="split_bam.SINGLE_END.bam" />
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
20 <data format="bam" name="paired" label="${input_bam.name} unmapped" from_work_dir="split_bam.PAIRED_END.bam" />
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
21 </outputs>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
22 <tests>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
23 <test>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
24 <param name="input_bam" ftype="bam" value="bamtools-input-paired.bam"/>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
25 <output name="single" file="split_bam.SINGLE_END.bam" compare="sim_size" delta="200" />
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
26 <output name="paired" file="split_bam.PAIRED_END.bam" compare="sim_size" delta="200" />
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
27 </test>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
28 </tests>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
29 <help>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
30 **What is does**
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
31
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
32 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).
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
33
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
34 -----
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
35
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
36 .. class:: warningmark
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
37
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
38
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
39 **How it works**
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
40
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
41
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
42 Splits the input BAM file into 2 output files named (SINGLE_END) and (PAIRED_END) containing single_end and paired_end reads, respectively.
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
43
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
44 -----
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
45
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
46 .. class:: infomark
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
47
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
48 **More information**
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
49
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
50 Additional information about BAMtools can be found at https://github.com/pezmaster31/bamtools/wiki
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
51
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
52 </help>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
53 <citations>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
54 <citation type="doi">10.1093/bioinformatics/btr174</citation>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
55 </citations>
8c17ddca0eee Uploaded
jjohnson
parents:
diff changeset
56 </tool>