view sniffles.xml @ 0:ee65e517769d draft

planemo upload for repository https://github.com/youyuh48/galaxy-tools/tree/master/tools/sniffles

<tool id="sniffles" name="sniffles" version="0.1.0">
  <description>Structural variation caller using third generation sequencing</description>
  <requirements>
    <requirement type="package" version="1.0.11">sniffles</requirement>
  </requirements>
  <command detect_errors="exit_code">
    <![CDATA[
sniffles
-t \${GALAXY_SLOTS:-2}
-m '$input'
--${output_format} '$output'
## general_options
#if $general_options.s:
    -s $general_options.s
#end if
#if $general_options.max_num_splits:
    --max_num_splits $max_num_splits
#end if
#if $general_options.l:
    -l $general_options.l
#end if
#if $general_options.q:
    -q $general_options.q
#end if
#if $general_options.n:
    -n $general_options.n
#end if
#if $general_options.r:
    -r $general_options.r
#end if
    ]]>
  </command>
  <inputs>
    <param type="data" name="input" format="bam" label="Input BAM file"/>
    <param name="output_format" type="select" label="Select an output format">
      <option value="vcf">VCF</option>
      <option value="bedpe">bedpe</option>
    </param>
    <section name="general_options" title="Set general options" expanded="False">
      <param argument="-s" type="integer" value="" optional="true" label="Minimum number of reads that support a SV. [10]"/>
      <param argument="--max_num_splits" name="max_num_splits" type="integer" value="" optional="true" label="Maximum number of splits per read to be still taken into account. [7]"/>
      <param argument="-l" type="integer" value="" optional="true" label="Minimum length of SV to be reported. [30]"/>
      <param argument="-q" type="integer" value="" optional="true" label="Minimum Mapping Quality. [20]"/>
      <param argument="-n" type="integer" value="" optional="true" label="Report up to N reads that support the SV in the vcf file. -1: report all. [0]"/>
      <param argument="-r" type="integer" value="" optional="true" label="Discard read if non of its segment is larger then this. [2000]"/>
    </section>
  </inputs>
  <outputs>
    <data name="output" format="vcf" label="${tool.name} on ${on_string} (${output_format} format)">
      <change_format>
        <when input="output_format" value="bedpe" format="tabular"/>
      </change_format>
    </data>
  </outputs>
  <tests>
    <test>
      <param name="input" value="reads_region.bam"/>
      <param name="option" value="--vcf"/>
      <output name="output" file="expected_output.vcf"/>
    </test>
  </tests>
  <help>
    <![CDATA[
Usage: sniffles [options] -m <sorted.bam> -v <output.vcf>

Input/Output:
    -m <string>,  --mapped_reads <string>
        (required)  Sorted bam File
    -v <string>,  --vcf <string>
        VCF output file name []
    -b <string>,  --bedpe <string>
         bedpe output file name []
    \--Ivcf <string>
        Input VCF file name. Enable force calling []
    \--tmp_file <string>
        path to temporary file otherwise Sniffles will use the current directory. []

General:
    -s <int>,  --min_support <int>
        Minimum number of reads that support a SV. [10]
    \--max_num_splits <int>
        Maximum number of splits per read to be still taken into account. [7]
    -d <int>,  --max_distance <int>
        Maximum distance to group SV together. [1000]
    -t <int>,  --threads <int>
        Number of threads to use. [3]
    -l <int>,  --min_length <int>
        Minimum length of SV to be reported. [30]
    -q <int>,  --minmapping_qual <int>
        Minimum Mapping Quality. [20]
    -n <int>,  --num_reads_report <int>
        Report up to N reads that support the SV in the vcf file. -1: report all. [0]
    -r <int>,  --min_seq_size <int>
        Discard read if non of its segment is larger then this. [2000]
    -z <int>,  --min_zmw <int>
        Discard SV that are not supported by at least x zmws. This applies only for PacBio recognizable reads. [0]
    \--cs_string
        Enables the scan of CS string instead of Cigar and MD.  [false]

Clustering/phasing and genotyping:
    \--genotype
        Enables Sniffles to compute the genotypes. [false]
    \--cluster
        Enables Sniffles to phase SVs that occur on the same reads [false]
    \--cluster_support <int>
        Minimum number of reads supporting clustering of SV. [1]
    -f <float>,  --allelefreq <float>
        Threshold on allele frequency (0-1).  [0]
    \--min_homo_af <float>
        Threshold on allele frequency (0-1).  [0.8]
    \--min_het_af <float>
        Threshold on allele frequency (0-1).  [0.3]

Advanced:
    \--report_BND
        Dont report BND instead use Tra in vcf output.  [true]
    \--report_seq
        Report sequences for indels in vcf output. (Beta version!)  [false]
    \--ignore_sd
        Ignores the sd based filtering.  [false]
    \--report_read_strands
        Enables the report of the strand categories per read. (Beta)  [false]
    \--ccs_reads
        Preset CCS Pacbio setting. (Beta)  [false]

Parameter estimation:
    \--skip_parameter_estimation
        Enables the scan if only very few reads are present.  [false]
    \--del_ratio <float>
        Estimated ration of deletions per read (0-1).  [0.0458369]
    \--ins_ratio <float>
        Estimated ratio of insertions per read (0-1).  [0.049379]
    \--max_diff_per_window <int>
        Maximum differences per 100bp. [50]
    \--max_dist_aln_events <int>
        Maximum distance between alignment (indel) events. [4]
    ]]>
  </help>
    <citations>
        <citation type="doi">10.1038/s41592-018-0001-7</citation>
    </citations>
</tool>