annotate snippy.xml @ 3:8b69e4b18a5f draft

Added more dependencies
author simon-gladman
date Mon, 06 Jun 2016 00:54:10 -0400
parents 2d400172381a
children f0b139f53e1f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
1 <tool id="snippy" name="snippy" version="0.2.0">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
2 <requirements>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
3 <requirement type="package" version="3.0">snippy</requirement>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
4 <requirement type="package" version="1.2">samtools</requirement>
1
e1b47f2236b6 Added more dependencies
simon-gladman
parents: 0
diff changeset
5 <requirement type="package" version="0_9_20_b040236">freebayes</requirement>
e1b47f2236b6 Added more dependencies
simon-gladman
parents: 0
diff changeset
6 <requirement type="package" version="0.7.12">bwa</requirement>
e1b47f2236b6 Added more dependencies
simon-gladman
parents: 0
diff changeset
7 <requirement type="package" version="0.1.11">vcftools</requirement>
e1b47f2236b6 Added more dependencies
simon-gladman
parents: 0
diff changeset
8 <requirement type="package" version="4.0">snpeff</requirement>
3
8b69e4b18a5f Added more dependencies
simon-gladman
parents: 2
diff changeset
9 <requirement type="package" version="8a5602bf07">vcflib</requirement>
0
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
10 </requirements>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
11 <stdio>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
12 <exit_code range="1:" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
13 </stdio>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
14
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
15 <command><![CDATA[
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
16 cp $ref foo.fna &&
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
17 snippy
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
18 --outdir out
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
19 --cpus "\${GALAXY_SLOTS:-1}"
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
20 --ref foo.fna
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
21 $cleanup
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
22 #if str( $advanced.is_advanced ) == "advanced"
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
23 --mapqual $advanced.mapqual
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
24 --mincov $advanced.mincov
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
25 --minfrac $advanced.minfrac
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
26 #if $advanced.rgid
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
27 --rgid $advanced.rgid
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
28 #end if
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
29 #if $advanced.bwaopt
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
30 --bwaopt $advanced.bwaopt
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
31 #end if
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
32 #end if
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
33 #if str( $fastq_input.fastq_input_selector ) == "paired"
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
34 --pe1 $fastq_input.fastq_input1
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
35 --pe2 $fastq_input.fastq_input2
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
36 #end if
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
37 #if str( $fastq_input.fastq_input_selector ) == "paired_collection"
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
38 --pe1 $fastq_input.fastq_input1.forward
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
39 --pe2 $fastq_input.fastq_input1.reverse
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
40 #end if
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
41 #if str( $fastq_input.fastq_input_selector ) == "single"
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
42 --se $fastq_input.fastq_input1
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
43 #end if
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
44 #if str( $fastq_input.fastq_input_selector ) == "paired_iv"
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
45 --peil $fastq_input.fastq_input1
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
46 #end if
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
47
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
48 &&
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
49
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
50 gunzip out/snps.depth.gz
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
51
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
52
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
53 ]]></command>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
54 <inputs>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
55 <param name="ref" type="data" format="fasta" label="Reference Fasta" help="Fasta file to use as the reference" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
56 <conditional name="fastq_input">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
57 <param name="fastq_input_selector" type="select" label="Single or Paired-end reads" help="Select between paired and single end data">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
58 <option value="paired">Paired</option>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
59 <option value="single">Single</option>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
60 <option value="paired_collection">Paired Collection</option>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
61 <option value="paired_iv">Paired Interleaved</option>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
62 </param>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
63 <when value="paired">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
64 <param name="fastq_input1" type="data" format="fastqsanger,fasta" label="Select first set of reads" help="Specify dataset with forward reads"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
65 <param name="fastq_input2" type="data" format="fastqsanger,fasta" label="Select second set of reads" help="Specify dataset with reverse reads"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
66 </when>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
67 <when value="single">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
68 <param name="fastq_input1" type="data" format="fastqsanger,fasta" label="Select fastq dataset" help="Specify dataset with single reads"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
69 </when>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
70 <when value="paired_collection">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
71 <param name="fastq_input1" format="fastqsanger,fasta" type="data_collection" collection_type="paired" label="Select a paired collection" help="See help section for an explanation of dataset collections"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
72 </when>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
73 <when value="paired_iv">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
74 <param name="fastq_input1" type="data" format="fastqsanger" label="Select fastq dataset" help="Specify dataset with interleaved reads"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
75 </when>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
76 </conditional>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
77 <param name="cleanup" type="boolean" checked="true" truevalue="--cleanup" falsevalue="" label="Cleanup the non-snp output files" help="Remove all non-SNP files: BAMs, indices etc" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
78 <conditional name="advanced">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
79 <param name="is_advanced" type="select" label="Advanced parameters" help="unhide advanced parameter settings">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
80 <option value="advanced">Show advanced settings</option>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
81 <option value="simple" selected="true">Hide advanced settings</option>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
82 </param>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
83 <when value="advanced">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
84 <param name="mapqual" type="float" value="60" label="Minimum mapping quality" help="Minimum mapping quality to allow" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
85 <param name="mincov" type="float" value="10" label="Minimum coverage" help="Minimum coverage to call a snp" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
86 <param name="minfrac" type="float" value="0.9" label="Minumum proportion for variant evidence" help="Minumum proportion for variant evidence" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
87 <param name="rgid" type="text" value="" label="Bam header @RG ID" help="Use this @RG ID: in the BAM header" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
88 <param name="bwaopt" type="text" value="" label="Extra BWA MEM options" help="Extra BWA MEM options, eg. -x pacbio" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
89 </when>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
90 <when value="simple">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
91
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
92 </when>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
93 </conditional>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
94 </inputs>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
95 <outputs>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
96 <data format="vcf" name="snpvcf" label="${tool.name} on ${on_string} snps vcf file" from_work_dir="out/snps.vcf"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
97 <data format="gff3" name="snpgff" label="${tool.name} on ${on_string} snps gff file" from_work_dir="out/snps.gff"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
98 <data format="tabular" name="snptab" label="${tool.name} on ${on_string} snps table" from_work_dir="out/snps.tab"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
99 <data format="tabular" name="snpsum" label="${tool.name} on ${on_string} snps summary" from_work_dir="out/snps.txt"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
100 <data format="text" name="snplog" label="${tool.name} on ${on_string} log file" from_work_dir="out/snps.log"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
101 <data format="fasta" name="snpalign" label="${tool.name} on ${on_string} aligned fasta" from_work_dir="out/snps.aligned.fa"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
102 <data format="fasta" name="snpconsensus" label="${tool.name} on ${on_string} consensus fasta" from_work_dir="out/snps.consensus.fa"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
103 <data format="tabular" name="snpsdepth" label="${tool.name} on ${on_string} mapping depth" from_work_dir="out/snps.depth"/>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
104 <data format="bam" name="snpsbam" label="${tool.name} on ${on_string} mapped reads (bam)" from_work_dir="out/snps.bam">
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
105 <filter>cleanup is False</filter>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
106 </data>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
107 </outputs>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
108
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
109 <tests>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
110 <test>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
111 <param name="ref" value="Ecoli.fna" ftype="fasta" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
112 <param name="fastq_input_selector" value="paired" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
113 <param name="fastq_input1" ftype="fastq" value="reads_1.fq" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
114 <param name="fastq_input2" ftype="fastq" value="reads_2.fq" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
115 <output name="snpsum" ftype="tabular" file="test/snps.txt" lines-diff="5" />
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
116 </test>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
117 </tests>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
118
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
119
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
120 <help><![CDATA[
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
121 This is a change to force a reinstall
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
122 Synopsis:
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
123 snippy 3.0 - fast bacterial variant calling from NGS reads
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
124 Author:
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
125 Torsten Seemann <torsten.seemann@gmail.com>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
126 Usage:
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
127 snippy [options] --outdir <dir> --ref <ref> --pe1 <R1.fq.gz> --pe2 <R2.fq.gz>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
128 snippy [options] --outdir <dir> --ref <ref> --se <454.fastq>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
129 snippy [options] --outdir <dir> --ref <ref> --peil <velvet.fa.gz>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
130 Options:
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
131 --help This help
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
132 --version Print version and exit
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
133 --citation Print citation for referencing snippy
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
134 --quiet No screen output (default OFF)
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
135 --cpus [N] Maximum number of CPU cores to use (default '8')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
136 --reference [X] Reference genome. Supports FASTA, GenBank, EMBL (not GFF) (default '')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
137 --outdir [X] Output folder (default '')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
138 --prefix [X] Prefix for output files (default 'snps')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
139 --force Force overwrite of existing output folder (default OFF)
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
140 --pe1|R1|left [X] Reads, paired-end R1 (left) (default '')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
141 --pe2|R2|right [X] Reads, paired-end R2 (right) (default '')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
142 --se|single [X] Single-end reads (default '')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
143 --peil [X] Reads, paired-end R1/R2 interleaved (default '')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
144 --mapqual [n.n] Minimum mapping quality to allow (default '60')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
145 --mincov [N] Minimum coverage of variant site (default '10')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
146 --minfrac [n.n] Minumum proportion for variant evidence (default '0.9')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
147 --report Produce long report with visual alignment (slow) (default OFF)
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
148 --cleanup Remove all non-SNP files: BAMs, indices etc (default OFF)
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
149 --rgid [X] Use this @RG ID: in the BAM header (default '')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
150 --bwaopt [X] Extra BWA MEM options, eg. -x pacbio (default '')
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
151
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
152 ]]></help>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
153
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
154 <citations>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
155 <citation type="bibtex">@UNPUBLISHED{Seemann2013,
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
156 author = "Seemann T",
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
157 title = "snippy: fast bacterial variant calling from NGS reads",
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
158 year = "2015",
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
159 note = "https://github.com/tseemann/snippy"}
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
160 </citation>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
161 </citations>
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
162
0801bffdfcc8 Initial upload
simon-gladman
parents:
diff changeset
163 </tool>