annotate cpo_snippy.xml @ 19:ab2a037ad69c draft

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