annotate extractSplitReads_BwaMem.xml @ 0:839c219ab0aa draft

planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
author hepcat72
date Fri, 10 Aug 2018 11:46:23 -0400
parents
children a20ac5d90c16
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
1 <tool id="extractsplitreads_bwamem"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
2 name="Extract Split Reads"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
3 version="0.1.0">
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
4
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
5 <description>from bwaMEM (part of lumpy-sv)</description>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
6
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
7 <requirements>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
8 <requirement type="package" version="0.2.14a">lumpy-sv</requirement>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
9 </requirements>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
10
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
11 <!-- Not sure yet how to call the command if the lumpy-sv package in bioconda doesn't put the script in an executable location on PATH -->
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
12
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
13 <version_command>extractSplitReads_BwaMem | grep ^extractSplitReads_BwaMem | cut -d v -f 2</version_command>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
14
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
15 <command detect_errors="aggressive">
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
16 <![CDATA[
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
17 extractSplitReads_BwaMem
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
18 -i '$input'
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
19 -n $numSplits
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
20 $includeDups
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
21 -m $minNonOverlap
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
22 > '$output'
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
23 ]]>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
24 </command>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
25
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
26 <inputs>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
27
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
28 <param format="sam" name="input" type="data" label="Sam alignment file" argument="--infile"/>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
29
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
30 <param name="numSplits"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
31 label="numSplits"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
32 argument="--numSplits"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
33
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
34 type="integer"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
35 value="2"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
36
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
37 help="The maximum number of split-read mappings to allow per read. Reads with more are excluded." />
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
38
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
39 <param name="includeDups"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
40 label="includeDups"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
41 argument="--includeDups"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
42
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
43 type="boolean"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
44 truevalue="--includeDups"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
45 falsevalue=""
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
46 checked="no"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
47 value="false"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
48
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
49 help="Include alignments marked as duplicates." />
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
50
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
51 <param name="minNonOverlap"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
52 label="minNonOverlap"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
53 argument="--minNonOverlap"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
54
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
55 type="integer"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
56 value="20"
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
57
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
58 help="Minimum non-overlap between split alignments on the query." />
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
59
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
60 </inputs>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
61 <outputs>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
62 <data format="sam" name="output" />
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
63 </outputs>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
64
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
65 <tests>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
66 <test>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
67 <param name="input" value="JS01-BWA-MEM.splitters.sam"/>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
68 <output name="output" file="JS01-BWA-MEM.splitters.out.sam"/>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
69 </test>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
70 <test>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
71 <param name="input" value="pe.pos_sorted.sam"/>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
72 <output name="output" file="pe.pos_sorted.out.sam"/>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
73 </test>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
74 </tests>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
75
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
76 <help>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
77 <![CDATA[
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
78
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
79 Usage: `extractSplitReads_BwaMem -i <file>`
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
80
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
81 extractSplitReads_BwaMem v0.1.0
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
82
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
83 Author: Ira Hall
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
84
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
85 Description: Get split-read alignments from bwa-mem in lumpy compatible format. Ignores reads marked as duplicates.
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
86
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
87 Works on read or position sorted SAM input. Tested on bwa mem v0.7.5a-r405.
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
88
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
89
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
90 Options:
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
91 -h, --help show this help message and exit
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
92 -i FILE, --inFile=FILE
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
93 A SAM file or standard input (-i stdin).
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
94 -n INT, --numSplits=INT
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
95 The maximum number of split-read mappings to allow per
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
96 read. Reads with more are excluded. Default=2
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
97 -d, --includeDups Include alignments marked as duplicates. Default=False
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
98 -m INT, --minNonOverlap=INT
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
99 minimum non-overlap between split alignments on the
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
100 query (default=20)
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
101
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
102 ]]>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
103 </help>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
104
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
105 <citations>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
106 <citation type="doi">doi:10.1186/gb-2014-15-6-r84</citation>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
107 </citations>
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
108
839c219ab0aa planemo upload commit 0066847e0ac19632c3091ac3148069de3bb3855f-dirty
hepcat72
parents:
diff changeset
109 </tool>