annotate fgbio_findswitchbackreads.xml @ 1:62f157ab67d1 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit fdd4ffa3adad8412f98305d809927691bafd2ed7
author iuc
date Tue, 04 Nov 2025 18:39:24 +0000
parents fe8744fd4198
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
1 <tool id="fgbio_findswitchbackreads" name="fgbio FindSwitchbackReads" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
2 <description>identifies reads derived from a template switch during library construction</description>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
3 <macros>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
4 <import>macros.xml</import>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
5 </macros>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
7 <expand macro="stdio"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
8 <expand macro="version_command"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
9 <command><![CDATA[
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
10 @PREPARE_FASTA_IDX@
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
11
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
12 ## Link input BAM file
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
13 ln -s '$input' input.bam &&
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
14
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
15 fgbio FindSwitchbackReads
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
16 --input input.bam
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
17 --output output.bam
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
18 --ref \$reffa
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
19 --sort-order Coordinate
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
20 #if str($max_offset) != '':
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
21 --max-offset $max_offset
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
22 #end if
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
23 #if str($max_gap) != '':
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
24 --max-gap $max_gap
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
25 #end if
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
26 #if str($min_length) != '':
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
27 --min-length $min_length
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
28 #end if
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
29 #if str($max_error_rate) != '':
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
30 --max-error-rate $max_error_rate
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
31 #end if
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
32 $dont_unmap
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
33 $metrics
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
34 ]]></command>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
35 <inputs>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
36 <param argument="--input" type="data" format="bam,sam" label="Input BAM/SAM file"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
37 <expand macro="mandatory_reference" argument="--ref" help="Reference genome fasta file"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
38 <param argument="--max-offset" type="integer" optional="true" min="0" value="35" label="Maximum offset" help="Maximum offset between end the two segments of the read on the reference. Set to 0 to disable read-based checks."/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
39 <param argument="--max-gap" type="integer" optional="true" min="0" value="500" label="Maximum gap" help="Maximum gap between R1 and R2 of tandem reads to call a template a switchback. Set to 0 to disable tandem-based checks."/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
40 <param argument="--min-length" type="integer" optional="true" min="1" value="6" label="Minimum match length" help="Minimum match length of the switched back segment."/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
41 <param argument="--max-error-rate" type="float" optional="true" min="0.0" max="1.0" value="0.1" label="Maximum error rate" help="Maximum mismatch error rate of switchback match to genome."/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
42 <param argument="--dont-unmap" type="boolean" truevalue="--dont-unmap" falsevalue="" checked="false" label="Don't unmap reads" help="IF true, do NOT unmap reads from switchback templates."/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
43 <param argument="--metrics" type="boolean" truevalue="--metrics metrics" falsevalue="" checked="false" label="Output metrics" help="Generate metrics files."/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
44 </inputs>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
45 <outputs>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
46 <data name="output" format="bam" from_work_dir="output.bam" label="${tool.name} on ${on_string}: output"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
47 <collection name="metrics_collection" type="list" label="${tool.name} on ${on_string}: metrics">
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
48 <filter>metrics</filter>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
49 <discover_datasets pattern="metrics\.(?P&lt;designation&gt;.+)\.txt" format="txt"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
50 </collection>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
51 <data name="metrics_plots" format="pdf" from_work_dir="metrics.plots.pdf" label="${tool.name} on ${on_string}: plots">
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
52 <filter>metrics</filter>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
53 </data>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
54 </outputs>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
55 <tests>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
56 <test expect_num_outputs="1">
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
57 <param name="input" value="test1_in.bam"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
58 <conditional name="addref_cond">
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
59 <param name="addref_select" value="history"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
60 <param name="ref" value="test1.fa"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
61 </conditional>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
62 <output name="output" file="test1_out.bam"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
63 </test>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
64 <test expect_num_outputs="1">
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
65 <param name="input" value="test1_in.bam"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
66 <conditional name="addref_cond">
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
67 <param name="addref_select" value="history"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
68 <param name="ref" value="test1.fa"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
69 </conditional>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
70 <param name="max_gap" value="0"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
71 <output name="output" file="test2_out.bam"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
72 </test>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
73 </tests>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
74 <help><![CDATA[
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
75 **What it does**
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
76
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
77 FindSwitchbackReads finds reads where a template switch occurred during library construction. Some library construction methods, notably ultra-low-input shotgun methods, are prone to template switching events that create molecules (templates, inserts) that instead of being a linear copy of a segment of genomic DNA, instead are chimeras formed by starting on one strand of DNA and then switching to the opposite strand.
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
78
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
79 **Algorithm**
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
80
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
81 Templates that contain strand switch events (switch-backs) are found by this tool in two different ways:
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
82
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
83 1. By looking at reads that contain soft-clipped bases at their 5' end that, when reverse complemented, matches the genome proximal to the 5'-most mapped base of the read (read-based switchbacks).
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
84
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
85 2. By identifying templates with 'FF' or 'RR' (aka tandem) orientation where it is surmised that the template switch occurred in the un-sequenced region of the template between R1 and R2 (tandem-based switchbacks).
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
86
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
87 **Input and Output**
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
88
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
89 The tool takes as input a SAM or BAM file and produces a filtered BAM file where switchback templates are identified and optionally unmapped. All reads from a switch-back template are tagged with an 'sb' tag that describes the nature of the switchback.
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
90
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
91 **Parameters**
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
92
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
93 - **Maximum offset**: Controls how far away to search for the reverse-complemented sequence
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
94 - **Maximum gap**: Maximum gap between R1 and R2 of tandem reads to call a template a switchback
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
95 - **Minimum match length**: Minimum number of soft-clipped bases that must exist to trigger the search
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
96 - **Maximum error rate**: Allows for some mismatches between the soft-clipped sequence and the genome
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
97 - **Don't unmap reads**: By default, switchback reads are made unmapped. This option prevents that behavior
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
98 - **Output metrics**: Generate summary metrics, length distributions, and plots
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
99
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
100 ]]></help>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
101 <expand macro="citations"/>
fe8744fd4198 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/fgbio commit 88711b338e90adc003a90930a43df3315b2ece70
iuc
parents:
diff changeset
102 </tool>