annotate clip_overlap.xml @ 0:79725ecf10a3 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
author iuc
date Mon, 29 Mar 2021 14:15:42 +0000
parents
children 047a20d4258f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
1 <tool id="bamutil_clip_overlap" name="BamUtil clipOverlap" version="@WRAPPER_VERSION@" profile="@PROFILE@">
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
2 <description></description>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
3 <macros>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
5 </macros>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
7 <expand macro="edam"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
9 ## clipOverlap uses the output file
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
10 ## extension to determine the output format.
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
11 #if $input.ext.endswith('bam'):
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
12 #set tmp_out = 'output.bam'
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
13 #else:
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
14 #set tmp_out = 'output.sam'
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
15 #end if
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
16 trap '>&2 cat output.log' EXIT;
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
17 touch 'output.log' &&
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
18 bam clipOverlap
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
19 --in '$input'
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
20 #if str($storeOrig):
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
21 --storeOrig '$storeOrig'
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
22 #end if
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
23 $stats
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
24 #if str($input.ext) == 'qname_sorted.bam':
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
25 --readName
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
26 #end if
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
27 $overlapsOnly
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
28 #if str($excludeFlags):
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
29 --excludeFlags $excludeFlags
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
30 #end if
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
31 $unmapped
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
32 --noPhoneHome
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
33 --out '$tmp_out'
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
34 2> 'output.log'
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
35 && mv '$tmp_out' '$output'
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
36 #if str($stats):
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
37 && cp 'output.log' '$output_stats'
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
38 #end if
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
39 ]]></command>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
40 <inputs>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
41 <param name="input" type="data" format="sam,bam,qname_sorted.bam" label="Select SAM or BAM file on which to clip overlapping read pairs"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
42 <param argument="--storeOrig" type="text" value="" label="Enter a tag in which to store the original CIGAR" help="Leave blank to skip">
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
43 <sanitizer invalid_char="">
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
44 <valid initial="string.letters,string.digits"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
45 </sanitizer>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
46 </param>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
47 <param argument="--stats" type="boolean" truevalue="--stats" falsevalue="" checked="false" label="Output statistics on the overlaps?"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
48 <param argument="--overlapsOnly" type="boolean" truevalue="--overlapsOnly" falsevalue="" checked="false" label="Only output overlapping read pairs?"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
49 <param argument="--excludeFlags" type="integer" optional="true" value="" label="Enter an integer representation of a flag to skip records with any of the specified flags set" help="See the help section below for information about this option"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
50 <param argument="--unmapped" type="boolean" truevalue="--unmapped" falsevalue="" checked="false" label="Mark records that would be completely clipped as unmapped?"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
51 </inputs>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
52 <outputs>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
53 <data name="output" format_source="input" metadata_source="input"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
54 <data name="output_stats" format="txt" label="${tool.name} on ${on_string}: Statistics">
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
55 <filter>stats</filter>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
56 </data>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
57 </outputs>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
58 <tests>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
59 <test expect_num_outputs="1">
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
60 <param name="input" value="input.sam" ftype="sam"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
61 <output name="output" file="output.sam" ftype="sam"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
62 </test>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
63 <test expect_num_outputs="2">
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
64 <param name="input" value="input.bam" ftype="bam"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
65 <param name="storeOrig" value="6M"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
66 <param name="stats" value="--stats"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
67 <output name="output" file="input.bam" ftype="bam"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
68 <output name="output_stats" file="output_stats.txt" ftype="txt"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
69 </test>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
70 <test expect_num_outputs="1">
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
71 <param name="input" value="input_qname_sorted.bam" ftype="qname_sorted.bam"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
72 <output name="output" file="output_qname_sorted.bam" ftype="qname_sorted.bam"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
73 </test>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
74 </tests>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
75 <help>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
76 **What it does**
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
77
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
78 Clips overlapping read pairs in a SAM or BAM file based on criteria.
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
79
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
80 The input file and resulting output file are sorted by coordinate (or readName if specified in the options).
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
81
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
82 When a read is clipped from the front:
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
83
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
84 * the read start position is updated to reflect the clipping
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
85 * the mate's mate start position is updated to reflect the record's new position
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
86 * the record is placed in the output file in the correct location based on the updated position
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
87
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
88 To handle coordinate-sorted files, SAM/BAM records are buffered up until it is known that all following records will have a later start position. To prevent the program from running away with memory, a limit is set to the number of records that can be buffered, see --poolSize for more information.
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
89
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
90 When two mates overlap, this tool will clip the record's whose clipped region would have the lowest average quality.
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
91
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
92 It also checks strand. If a forward strand extends past the end of a reverse strand, that will be clipped. Similarly, if a reverse strand starts before the forward strand, the region prior to the forward strand will be clipped. If the reverse strand occurs entirely before the forward strand, both strands will be entirely clipped. If the --unmapped option is specified, then rather than clipping an entire read, it will be marked as unmapped.
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
93 The qualities on the two strands remain unchanged even with clipping.
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
94
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
95 The excludeFlags option accepts a decimal value and skips the records with the specified flags set. The default is 3852 (0xF0C hex), so records with any of the following flags set will be skipped:
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
96
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
97 * unmapped
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
98 * mate unmapped
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
99 * secondary alignment
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
100 * fails QC checks
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
101 * duplicate
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
102 * supplementary
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
103
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
104 **Assumptions/ Restrictions**
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
105
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
106 * Assumes the file is sorted by Coordinate (or ReadName if using --readName option)
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
107 * Assumes only 2 reads have matching ReadNames (Supplementary and Secondary reads are ignored/skipped by default so will not cause a problem)
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
108
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
109 * It matches in pairs, so if there are 3, the first 2 will be matched and compared, but the 3rd won't. If there are 4, the first 2 will be matched and the last 2 will be matched and compared.
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
110
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
111 * Only mapped reads will be clipped
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
112 * Assumes that mate information in records are accurate
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
113
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
114 **Clipping from the front**
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
115
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
116 The first operation after the softclip will be a Match/Mismatch, meaning that any trailing pads, deletions, insertions, or skips will also be soft clipped.
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
117
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
118 +------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
119 | Clip location | How it is handled |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
120 +================================+=========================================================+======================================================================================+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
121 | If the clip position falls in a skip/deletion | Removes the entire skip/deletion |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
122 +------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
123 | If the position immediately after the clip is a skip/deletion | Also removes the skip/deletion |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
124 +------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
125 | If the position immediately after the clip is an Insert | Softclips the insert |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
126 +------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
127 | If the position immediately after the clip is a Pad | Removes the pad |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
128 +------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
129 | Clip occurs at the last match/mismatch position of the read (the entire read is clipped) | Entire read is soft clipped, 0-based position is left as the original (not modified) |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
130 +------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
131 | Clip occurs after the read ends | Entire read is soft clipped, 0-based position is left as the original (not modified) |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
132 +------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
133 | Clip occurs before the read starts | Nothing is clipped. The read is not changed. |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
134 +------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
135
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
136 **Clipping from the back**
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
137
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
138 +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
139 | Clip location | How it is handled |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
140 +==================+=========================================================+===================================================================================================================+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
141 | If the clip position falls in a skip/deletion | Removes the entire skip/deletion |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
142 +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
143 | If the position immediately before the clip is a deletion/skip/pad | Remove the deletion/skip/pad |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
144 +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
145 | If the position immediately before the clip is an insertion | Leave the insertion, even if it results in a 70M3I27S |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
146 +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
147 | Clip occurs at the first position of the read (the entire read is clipped) | Entire read is soft clipped, preceding insertions remain, 0-based position is left as the original (not modified) |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
148 +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
149 | Clip occurs before the read starts | Entire read is soft clipped, 0-based position is left as the original (not modified) |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
150 +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
151 | Clip occurs after the read ends | Nothing is clipped. The read is not changed. |
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
152 +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
153
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
154 </help>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
155 <expand macro="citations"/>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
156 </tool>
79725ecf10a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bamutil commit 29e40a76f1e249c3ed73f9129ad711beba34eb07"
iuc
parents:
diff changeset
157