annotate sniffles.xml @ 1:e36c52a0b8a6 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
author iuc
date Wed, 01 Sep 2021 08:39:08 +0000
parents 3ed49d47e64c
children 6f22f224ffc5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
1 <tool id="sniffles" name="sniffles" version="@TOOL_VERSION@+galaxy0">
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
2 <description>Structural variation caller using third generation sequencing</description>
1
e36c52a0b8a6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 0
diff changeset
3 <xrefs>
e36c52a0b8a6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 0
diff changeset
4 <xref type="bio.tools">sniffles</xref>
e36c52a0b8a6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 0
diff changeset
5 </xrefs>
0
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
6 <macros>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
7 <token name="@TOOL_VERSION@">1.0.12</token>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
8 </macros>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
9 <requirements>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
10 <requirement type="package" version="@TOOL_VERSION@">sniffles</requirement>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
11 </requirements>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
12 <version_command>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
13 <![CDATA[ sniffles --version ]]>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
14 </version_command>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
15 <command detect_errors="exit_code">
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
16 <![CDATA[
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
17 ln -f -s '${input}' input.bam &&
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
18 ln -f -s '${input.metadata.bam_index}' input.bam.bai &&
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
19
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
20 sniffles
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
21 -t \${GALAXY_SLOTS:-2}
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
22 -m 'input.bam'
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
23 -v '$output'
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
24 ## general_options
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
25 #if $general_options.min_support:
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
26 --min_support $general_options.min_support
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
27 #end if
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
28 --max_num_splits $general_options.max_num_splits
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
29 #if $general_options.max_distance:
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
30 --max_distance $general_options.max_distance
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
31 #end if
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
32 #if $general_options.min_length:
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
33 --min_length $general_options.min_length
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
34 #end if
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
35 --minmapping_qual $general_options.minmapping_qual
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
36 --num_reads_report $general_options.num_reads_report
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
37 #if $general_options.min_seq_size:
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
38 --min_seq_size $general_options.min_seq_size
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
39 #end if
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
40 --min_zmw $general_options.min_zmw
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
41 $general_options.cs_string
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
42 ## clustering_options
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
43 $clustering_options.cluster
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
44 #if $clustering_options.cluster_support:
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
45 --cluster_support $clustering_options.cluster_support
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
46 #end if
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
47 --allelefreq $clustering_options.allelefreq
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
48 --min_homo_af $clustering_options.min_homo_af
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
49 --min_het_af $clustering_options.min_het_af
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
50 ##advanced_options
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
51 $advanced_options.report_BND
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
52 $advanced_options.not_report_seq
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
53 $advanced_options.ignore_sd
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
54 $advanced_options.ccs_reads
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
55 ## parameter_estimation_options
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
56 $parameter_estimation_options.skip_parameter_estimation
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
57 --del_ratio $parameter_estimation_options.del_ratio
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
58 --ins_ratio $parameter_estimation_options.ins_ratio
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
59 --max_diff_per_window $parameter_estimation_options.max_diff_per_window
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
60 --max_dist_aln_events $parameter_estimation_options.max_dist_aln_events
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
61 ]]>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
62 </command>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
63 <inputs>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
64 <param type="data" name="input" format="bam" label="Input BAM file"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
65 <section name="general_options" title="Set general options" expanded="False">
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
66 <param argument="--min_support" type="integer" value="10" optional="true" min="1" label="Minimum Support" help="Minimum number of reads that support a SV. [10]" />
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
67 <param argument="--max_num_splits" type="integer" value="7" optional="true" min="0" label="Maximum Number of Splits" help="Maximum number of splits per read to be still taken into account. [7]" />
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
68 <param argument="--max_distance" type="integer" value="1000" optional="true" min="10" label="Maximum Distance" help="Maximum distance to group SV together. [1000]" />
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
69 <param argument="--min_length" type="integer" value="30" optional="true" min="2" label="Minimum Length" help="Minimum length of SV to be reported. [30]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
70 <param argument="--minmapping_qual" type="integer" value="20" optional="true" min="0" label="Minimum Mapping Quality" help="Minimum Mapping Quality. [20]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
71 <param argument="--num_reads_report" type="integer" value="0" optional="true" min="-1" label="Number of reads to report" help="Report up to N reads that support the SV in the vcf file. -1: report all. [0]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
72 <param argument="--min_seq_size" type="integer" value="" optional="true" label="Minimum Seq Size" help="Discard read if non of its segment is larger then this. [2000]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
73 <param argument="--min_zmw" type="integer" value="0" optional="true" min="0" label="Minimum ZMW" help="Discard SV that are not supported by at least x zmws. This applies only for PacBio recognizable reads. [0]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
74 <param argument="--cs_string" type="boolean" truevalue="--cs_string" falsevalue="" optional="true" label="Enable CS String" help="Enables the scan of CS string instead of Cigar and MD. [false]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
75 </section>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
76 <section name="clustering_options" title="Clustering/phasing and genotyping options" expanded="False">
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
77 <param argument="--cluster" type="boolean" truevalue="--cluster" falsevalue="" optional="true" label="Cluster" help="Enables Sniffles to phase SVs that occur on the same reads [false]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
78 <param argument="--cluster_support" type="integer" value="1" optional="true" min="1" label="Cluster Support" help="Minimum number of reads supporting clustering of SV. [1]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
79 <param argument="--allelefreq" type="float" value="0" optional="true" min="0" label="Allele Frequency Threshold" help="Filters the SV calls based on the allele frequency. [0]" />
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
80 <param argument="--min_homo_af" type="float" value="0.8" optional="true" min="0" max="1" label="Minimum Homogenous Allele Frequency" help="Minimum homogeneous threshold on allele frequency (0-1). [0.8]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
81 <param argument="--min_het_af" type="float" value="0.3" optional="true" min="0" max="1" label="Minimum Heterogeneous Allele Frequency" help="Minimum heterogeneous threshold on allele frequency (0-1). [0.3]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
82 </section>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
83 <section name="advanced_options" title="Advanced options" expanded="False">
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
84 <param argument="--report_BND" type="boolean" value="True" truevalue="--report_BND" falsevalue="" optional="true" label="Report BND" help="Report BND instead of Tra in vcf output. [true]" />
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
85 <param argument="--not_report_seq" type="boolean" value="False" truevalue="--not_report_seq" falsevalue="" optional="true" label="Don't report seq" help="Don't report sequences for indels in vcf output. (Beta version!) [false]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
86 <param argument="--ignore_sd" type="boolean" value="False" truevalue="--ignore_sd" falsevalue="" optional="true" label="Igonore sd" help="Ignores the sd based filtering. [false]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
87 <param argument="--ccs_reads" type="boolean" value="False" truevalue="--ccs_reads" falsevalue="" optional="true" label="CCS Reads" help="Preset CCS Pacbio setting. (Beta) [false]" />
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
88 </section>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
89 <section name="parameter_estimation_options" title="Parameter Estimation Options" expanded="False">
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
90 <param argument="--skip_parameter_estimation" type="boolean" value="False" truevalue="--skip_parameter_estimation" falsevalue="" optional="true" label="Skip Parameter Estimation" help="Enables the scan if only very few reads are present. [false]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
91 <param argument="--del_ratio" type="float" value="0.0458369" optional="true" min="0" max="1" label="Estimated Deletion Ratio" help="Estimated ratio of deletions per read (0-1). [0.0458369]" />
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
92 <param argument="--ins_ratio" type="float" value="0.049379" optional="true" min="0" max="1" label="Estimated Insertion Ratio" help="Estimated ratio of insertions per read (0-1). [0.049379]" />
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
93 <param argument="--max_diff_per_window" type="integer" value="50" optional="true" min="0" label="Maximum Differences Per Window" help="Maximum differences per 100bp. [50]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
94 <param argument="--max_dist_aln_events" type="integer" value="4" optional="true" min="0" label="Maximum Distance Between Alignment Events" help="Maximum distance between alignment (indel) events. [4]"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
95 </section>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
96 </inputs>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
97 <outputs>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
98 <data name="output" format="vcf" label="${tool.name} on ${on_string}"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
99 </outputs>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
100 <tests>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
101 <test> <!-- test 1 - standard run -->
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
102 <param name="input" value="reads_region.bam"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
103 <param name="output_format" value="vcf"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
104 <output name="output" file="expected_output.vcf" lines_diff="2"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
105 </test>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
106 <test> <!-- test 2 - add reads into report -->
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
107 <param name="input" value="reads_region.bam"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
108 <param name="output_format" value="vcf"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
109 <param name="num_reads_report" value="-1"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
110 <output name="output" file="expected_output2.vcf" lines_diff="2"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
111 </test>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
112 <test> <!-- test 3 - use cs_string -->
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
113 <param name="input" value="reads_region.bam"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
114 <param name="output_format" value="vcf"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
115 <param name="cs_string" value="true"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
116 <output name="output" file="expected_outcome3.vcf" lines_diff="2"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
117 </test>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
118 <test> <!-- test 4 - clustering -->
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
119 <param name="input" value="reads_region.bam"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
120 <param name="output_format" value="vcf"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
121 <param name="cluster" value="True"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
122 <output name="output" file="expected_outcome4.vcf" lines_diff="2"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
123 </test>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
124 <test> <!-- test 5 - Advanced - Report BND -->
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
125 <param name="input" value="reads_region.bam"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
126 <param name="output_format" value="vcf"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
127 <param name="report_BND" value="True"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
128 <output name="output" file="expected_outcome5.vcf" lines_diff="2"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
129 </test>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
130 <test> <!-- test 6 - Parameter Estimation - skip -->
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
131 <param name="input" value="reads_region.bam"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
132 <param name="output_format" value="vcf"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
133 <param name="skip_parameter_estimation" value="True"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
134 <output name="output" file="expected_outcome6.vcf" lines_diff="2"/>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
135 </test>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
136 </tests>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
137 <help>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
138 <![CDATA[
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
139 ########
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
140 Sniffles
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
141 ########
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
142
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
143 What is Sniffles?
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
144 *****************
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
145 Sniffles is a SV caller for long reads. It is mainly designed for PacBio reads, but also works on Oxford Nanopore reads. SV are larger events on the genome (e.g. deletions, duplications, insertions, inversions and translocations). Sniffles can detect all of these type and more such as nested SVs (e.g. inversion flanked by deletions or an inverted duplication). Furthermore, Sniffles incorporates multiple auto tuning functions to determine data set depending parameter to reduce the overall risk of falsely infer SVs.
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
146
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
147 Quick Start
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
148 ***********
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
149
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
150 Make sure you have a sorted bam file either from ngmlr or from bwa. For the later make sure you have used -M parameter for mapping to mark which alignments are primary and which are secondary! Note you have to adjust the parameters for low coverage cases.
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
151
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
152 Parameters
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
153 **********
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
154
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
155 General
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
156 -------
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
157
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
158 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
159 | Parameter | Description |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
160 +===========================+=======================================================================+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
161 | Minimum Support | Minimum number of reads that support a SV to be reported. Default: 10 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
162 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
163 | Maximum Number of Splits | Maximum number of split segments a read is aligned at before it is |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
164 | | ignored. Default: 7 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
165 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
166 | Maximum Distance | Maximum distance to group SV together. Sniffles estimates this |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
167 | | parameter during runtime to group together SVs reported by different |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
168 | | reads. Default: 1kb |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
169 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
170 | Minimum Length | Minimum length of SV to be reported. Default: 30bp |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
171 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
172 | Minimum Mapping Quality | Minimum mapping quality of alignment to be taken into account. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
173 | | Default: 20 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
174 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
175 | Number of Reads to Report | Number of read names to be reported that support the SV in the vcf |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
176 | | file. Default: 0 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
177 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
178 | Minimum Seq Size | Discard read if none of its segment is larger then this. Default: 2kb |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
179 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
180 | Minimum ZMW | Discard SV that are not supported by at least x zmws. This applies |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
181 | | only for PacBio recognizable reads. Default: 0 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
182 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
183 | Enable CS String | Enables the scan of CS string instead of Cigar and MD. Default: False|
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
184 +---------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
185
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
186 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
187
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
188 Clustering Options
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
189 ------------------
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
190
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
191 +----------------------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
192 | Parameter | Description |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
193 +========================================+=======================================================================+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
194 | Cluster | Performs read based phasing to mark SVs that occur together. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
195 +----------------------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
196 | Cluster Support | Minimum number of reads supporting clustering of SV. Default: 1 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
197 +----------------------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
198 | Allele Frequency Threshold | Filters the SV calls based on the allele frequency. Default: 0.0 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
199 +----------------------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
200 | Minimum Homogenous Allele Frequency | Minimum homogeneous threshold on allele frequency. Default: 0.8 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
201 +----------------------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
202 | Minimum Heterogeneous Allele Frequency | Minimum heterogeneous threshold on allele frequency. Default: 0.3 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
203 +----------------------------------------+-----------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
204
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
205 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
206
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
207 Advanced Options
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
208 ----------------
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
209
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
210 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
211 | Parameter | Description |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
212 +========================================+========================================================================+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
213 | Report BND | Reports the inversions and translocations as BND events. Default: False|
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
214 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
215 | Don't Report Seq | Don't report sequences for indels in vcf output. (Beta version!) |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
216 | | Default: False |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
217 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
218 | Ignore sd | Ignores the sd based filtering. Default: False |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
219 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
220 | CCS Reads | Preset CCS Pacbio setting. (Beta) Default: False |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
221 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
222
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
223 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
224
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
225 Parameter Estimation Options
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
226 ----------------------------
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
227
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
228 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
229 | Parameter | Description |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
230 +========================================+========================================================================+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
231 | Skip Parameter Estimation | Enables the scan if only very few reads are present. Default: False |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
232 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
233 | Estimated Deletion Ratio | Estimated ratio of deletions per read. Default: 0.0458369 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
234 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
235 | Estimated Insertion Ratio | Estimated ratio of insertions per read. Default: 0.049379 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
236 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
237 | Maximum Differences Per Window | Maximum differences per 100bp. Default: 50 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
238 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
239 | Maximum Distance Between Alignment | Maximum distance between alignment (indel) events. Default: 4 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
240 | Events | |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
241 +----------------------------------------+------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
242
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
243 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
244
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
245 Output
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
246 ******
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
247
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
248 VCF Info field description
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
249 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
250 Sniffles report multiple information in the Info field. The entries are delimited by:
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
251 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
252 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
253 | IMPRECISE/PRECISE | Indicates the confidence of the exact breakpoint positions (bp). |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
254 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
255 | CHR2= | The chromosome of the second breakpoint of the SV reported. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
256 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
257 | END= | The position (bp) of the second breakpoint of the SV reported. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
258 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
259 | ZMW= | For PacBio based reads, shows the number of ZMW that support the SV. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
260 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
261 | SVTYPE= | The type of the SV. (see Alt field above) |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
262 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
263 | SUPTYPE= | Indicates what evidence supports the SVs (SR: Split Reads, AL: Alignment, NR: Noisy Region). |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
264 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
265 | STD_quant_start= | The standard deviation of the start breakpoints. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
266 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
267 | STD_quant_stop= | The standard deviation of the stop breakpoints. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
268 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
269 | RNAMES= | A comma separated list of read names that support the SV event. Controlled by -n Parameter. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
270 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
271 | SVLEN= | Indicates the length of SVs. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
272 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
273 | STRANDS= | Strand information at both breakpoints. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
274 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
275 | SEQ= | If reportable shows the sequence of the indels. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
276 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
277 | RE= | Number of reads supporting the variance. |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
278 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
279 | AF= | Allele frequency (only if run with –genotype) |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
280 +-------------------+------------------------------------------------------------------------------------------------------+
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
281 |
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
282 Source: https://github.com/fritzsedlazeck/Sniffles/wiki
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
283 ]]>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
284 </help>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
285 <citations>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
286 <citation type="doi">10.1038/s41592-018-0001-7</citation>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
287 </citations>
3ed49d47e64c "planemo upload for repository https://github.com/galaxyproject/tools-iuc commit f5977355970ef4994957147d2d8a96fe6605e2b4"
iuc
parents:
diff changeset
288 </tool>