annotate snippy.xml @ 3:feb7e635c6af draft

planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
author iuc
date Tue, 02 Apr 2019 17:21:50 -0400
parents 776ebd1239da
children 0aa87d97847f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
1 <tool id="snippy" name="snippy" version="@VERSION@+galaxy2">
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
2 <description>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
3 Snippy finds SNPs between a haploid reference genome and your NGS sequence reads.
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
4 </description>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
5 <macros>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
6 <import>macros.xml</import>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
7 </macros>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
8 <expand macro="requirements" />
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
9 <expand macro="version_command" />
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
10
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
12
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
13 #if $ref.is_of_type("fasta")
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
14 cp '$ref' 'ref.fna' &&
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
15 #end if
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
16 #if $ref.is_of_type("genbank")
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
17 cp '$ref' 'ref.gbk' &&
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
18 #end if
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
19 snippy
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
20 --outdir 'out'
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
21 --cpus \${GALAXY_SLOTS:-1}
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
22 --ram \$((\${GALAXY_MEMORY_MB:-4096}/1024))
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
23 #if $ref.is_of_type("fasta")
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
24 --ref 'ref.fna'
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
25 #end if
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
26 #if $ref.is_of_type("genbank")
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
27 --ref 'ref.gbk'
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
28 #end if
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
29 --mapqual $adv.mapqual
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
30 --mincov $adv.mincov
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
31 --minfrac $adv.minfrac
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
32 --minqual $adv.minqual
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
33 #if $adv.rgid
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
34 --rgid '$adv.rgid'
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
35 #end if
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
36 #if $adv.bwaopt
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
37 --bwaopt '$adv.bwaopt'
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
38 #end if
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
39
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
40 #if str( $fastq_input.fastq_input_selector ) == "paired"
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
41 --R1 '$fastq_input.fastq_input1'
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
42 --R2 '$fastq_input.fastq_input2'
3
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
43 #elif str( $fastq_input.fastq_input_selector ) == "paired_collection"
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
44 --R1 '$fastq_input.fastq_input.forward'
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
45 --R2 '$fastq_input.fastq_input.reverse'
3
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
46 #elif str( $fastq_input.fastq_input_selector ) == "single"
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
47 --se '$fastq_input.fastq_input_single'
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
48 #elif str( $fastq_input.fastq_input_selector ) == "paired_iv"
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
49 --peil '$fastq_input.fastq_input_interleaved'
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
50 #end if
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
51
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
52 &&
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
53
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
54 #import re
1
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
55 #if str( $fastq_input.fastq_input_selector ) == "paired"
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
56 #set $dir_name = re.sub('[^\w_]', '_', $fastq_input.fastq_input1.element_identifier)
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
57 #elif str( $fastq_input.fastq_input_selector ) == "paired_collection"
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
58 #set $dir_name = re.sub('[^\w_]', '_', $fastq_input.fastq_input.name)
3
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
59 #elif str( $fastq_input.fastq_input_selector ) == "single"
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
60 #set $dir_name = re.sub('[^\w_]', '_', $fastq_input.fastq_input_single.element_identifier)
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
61 #elif str( $fastq_input.fastq_input_selector ) == "paired_iv"
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
62 #set $dir_name = re.sub('[^\w_]', '_', $fastq_input.fastq_input_interleaved.element_identifier)
1
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
63 #end if
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
64
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
65 mkdir -p ${dir_name} && cp -r out/reference out/snps.tab out/snps.aligned.fa out/snps.vcf ${dir_name}/ &&
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
66 tar -czf out.tgz ${dir_name}
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
67 #if "outcon" in str($outputs) and $adv.rename_cons
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
68 && sed -i 's/>.*/>${dir_name}/' out/snps.consensus.fa
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
69 #end if
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
70
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
71
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
72 ]]></command>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
73
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
74 <inputs>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
75
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
76 <param name="ref" type="data" format="fasta,genbank" label="Reference File (either in fasta or genbank format)" help="Fasta or Genbank file to use as the reference" />
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
77
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
78 <conditional name="fastq_input">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
79 <param name="fastq_input_selector" type="select" label="Single or Paired-end reads" help="Select between paired and single end data">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
80 <option value="paired">Paired</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
81 <option value="single">Single</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
82 <option value="paired_collection">Paired Collection</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
83 <option value="paired_iv">Paired Interleaved</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
84 </param>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
85 <when value="paired">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
86 <param name="fastq_input1" type="data" format="fastqsanger,fasta" label="Select first set of reads" help="Specify dataset with forward reads"/>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
87 <param name="fastq_input2" type="data" format="fastqsanger,fasta" label="Select second set of reads" help="Specify dataset with reverse reads"/>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
88 </when>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
89 <when value="single">
3
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
90 <param name="fastq_input_single" type="data" format="fastqsanger,fasta" label="Select fastq dataset" help="Specify dataset with single reads"/>
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
91 </when>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
92 <when value="paired_collection">
1
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
93 <param name="fastq_input" format="fastqsanger,fasta" type="data_collection" collection_type="paired" label="Select a paired collection" help="See help section for an explanation of dataset collections"/>
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
94 </when>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
95 <when value="paired_iv">
3
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
96 <param name="fastq_input_interleaved" type="data" format="fastqsanger" label="Select fastq dataset" help="Specify dataset with interleaved reads"/>
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
97 </when>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
98 </conditional>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
99
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
100 <section name="adv" title="Advanced parameters" expanded="false">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
101 <param name="mapqual" type="integer" value="60" label="Minimum mapping quality" help="Minimum mapping quality to allow" />
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
102 <param name="mincov" type="integer" value="10" label="Minimum coverage" help="Minimum coverage to call a snp" />
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
103 <param name="minfrac" type="float" value="0.9" label="Minumum proportion for variant evidence" help="Minumum proportion for variant evidence" />
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
104 <param name="minqual" type="float" value="100.0" label="Minumum QUALITY in VCF column 6" help="Minumum QUALITY in VCF column 6" />
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
105 <param name="rgid" type="text" value="" label="Bam header @RG ID" help="Use this @RG ID: in the BAM header" />
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
106 <param name="bwaopt" type="text" value="" label="Extra BWA MEM options" help="Extra BWA MEM options, eg. -x pacbio" />
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
107 <param name="rename_cons" type="boolean" truevalue="rename_cons" falsevalue="" help="When producing an output of the reference genome with variants instantiated, edit the header so that it is named after the input VCF" />
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
108 </section>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
109
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
110 <param name="outputs" type="select" multiple="true" display="checkboxes" label="Output selection">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
111 <option value="outvcf" selected="True">The final annotated variants in VCF format</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
112 <option value="outgff" selected="False">The variants in GFF3 format</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
113 <option value="outtab" selected="True">A simple tab-separated summary of all the variants</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
114 <option value="outsum" selected="False">A summary of the samples and mapping</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
115 <option value="outlog" selected="False">A log file with the commands run and their outputs</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
116 <option value="outaln" selected="False">A version of the reference but with - at position with depth=0 and N for 0 to depth to --mincov (does not have variants)</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
117 <option value="outcon" selected="False">A version of the reference genome with all variants instantiated</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
118 <option value="outdep" selected="False">Output of samtools depth for the .bam file</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
119 <option value="outbam" selected="False">The alignments in BAM format. Note that multi-mapping and unmapped reads are not present.</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
120 <option value="outzip" selected="True">Zipped files needed for input into snippy-core</option>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
121 </param>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
122
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
123 </inputs>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
124
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
125 <outputs>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
126
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
127 <data format="vcf" name="snpvcf" label="${tool.name} on ${on_string} snps vcf file" from_work_dir="out/snps.vcf">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
128 <filter>outputs and 'outvcf' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
129 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
130 <data format="gff3" name="snpgff" label="${tool.name} on ${on_string} snps gff file" from_work_dir="out/snps.gff">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
131 <filter>outputs and 'outgff' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
132 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
133 <data format="tabular" name="snptab" label="${tool.name} on ${on_string} snps table" from_work_dir="out/snps.tab">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
134 <filter>outputs and 'outtab' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
135 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
136 <data format="tabular" name="snpsum" label="${tool.name} on ${on_string} snps summary" from_work_dir="out/snps.txt">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
137 <filter>outputs and 'outsum' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
138 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
139 <data format="txt" name="snplog" label="${tool.name} on ${on_string} log file" from_work_dir="out/snps.log">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
140 <filter>outputs and 'outlog' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
141 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
142 <data format="fasta" name="snpalign" label="${tool.name} on ${on_string} aligned fasta" from_work_dir="out/snps.aligned.fa">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
143 <filter>outputs and 'outaln' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
144 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
145 <data format="fasta" name="snpconsensus" label="${tool.name} on ${on_string} consensus fasta" from_work_dir="out/snps.consensus.fa">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
146 <filter>outputs and 'outcon' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
147 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
148 <data format="tabular" name="snpsdepth" label="${tool.name} on ${on_string} mapping depth" from_work_dir="out/snps.depth">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
149 <filter>outputs and 'outdep' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
150 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
151 <data format="bam" name="snpsbam" label="${tool.name} on ${on_string} mapped reads (bam)" from_work_dir="out/snps.bam">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
152 <filter>outputs and 'outbam' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
153 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
154 <data format="zip" name="outdir" label="${tool.name} on ${on_string} dir for snippy core" from_work_dir="out.tgz">
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
155 <filter>outputs and 'outzip' in outputs</filter>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
156 </data>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
157
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
158 </outputs>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
159
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
160 <tests>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
161
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
162 <test> <!-- test 0 - fasta ref no snps -->
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
163 <param name="ref" value="reference.fasta" ftype="fasta" />
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
164 <param name="fastq_input_selector" value="paired" />
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
165 <param name="fastq_input1" ftype="fastqsanger" value="a_1.fastq" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
166 <param name="fastq_input2" ftype="fastqsanger" value="a_2.fastq" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
167 <param name="mincov" value="2" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
168 <param name="minqual" value="60" />
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
169 <param name="outputs" value="outgff,outsum" />
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
170 <output name="snpsum" ftype="tabular" file="a_fna_ref_mincov_2_minqual_60.snps.txt" lines_diff="6" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
171 <output name="snpgff" ftype="gff3" file="a_fna_ref_mincov_2_minqual_60.snps.gff" />
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
172 </test>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
173
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
174 <test> <!-- test 1 - fasta ref one snp -->
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
175 <param name="ref" value="reference.fasta" ftype="fasta" />
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
176 <param name="fastq_input_selector" value="paired" />
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
177 <param name="fastq_input1" ftype="fastqsanger" value="b_1.fastq" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
178 <param name="fastq_input2" ftype="fastqsanger" value="b_2.fastq" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
179 <param name="mincov" value="2" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
180 <param name="minqual" value="60" />
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
181 <param name="outputs" value="outgff,outsum" />
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
182 <output name="snpsum" ftype="tabular" file="b_fna_ref_mincov_2_minqual_60.snps.txt" lines_diff="6" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
183 <output name="snpgff" ftype="gff3" file="b_fna_ref_mincov_2_minqual_60.snps.gff" />
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
184 </test>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
185
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
186 <test> <!-- test 2 - fasta ref one snp paired_collection -->
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
187 <param name="ref" value="reference.fasta" ftype="fasta" />
1
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
188 <param name="fastq_input_selector" value="paired_collection" />
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
189 <param name="fastq_input">
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
190 <collection type="paired">
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
191 <element name="forward" ftype="fastqsanger" value="b_1.fastq" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
192 <element name="reverse" ftype="fastqsanger" value="b_2.fastq" />
1
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
193 </collection>
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
194 </param>
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
195 <param name="mincov" value="2" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
196 <param name="minqual" value="60" />
1
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
197 <param name="outputs" value="outgff,outsum" />
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
198 <output name="snpsum" ftype="tabular" file="b_fna_ref_mincov_2_minqual_60.snps.txt" lines_diff="6" />
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
199 <output name="snpgff" ftype="gff3" file="b_fna_ref_mincov_2_minqual_60.snps.gff" />
1
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
200 </test>
82f2b6f20fa2 planemo upload commit c295a06009ccafd0c1dc8aba5dd87239795d2b61
iuc
parents: 0
diff changeset
201
3
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
202 <test> <!-- test 3 - fasta ref one snp single -->
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
203 <param name="ref" value="reference.fasta" ftype="fasta" />
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
204 <param name="fastq_input_selector" value="single" />
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
205 <param name="fastq_input_single" value="b_2.fastq" ftype="fastqsanger" />
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
206 <param name="mincov" value="2" />
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
207 <param name="minqual" value="60" />
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
208 <param name="outputs" value="outgff,outsum" />
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
209 <output name="snpsum" ftype="tabular" file="b_fna_ref_mincov_2_minqual_60.snps.txt" lines_diff="6" />
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
210 <output name="snpgff" ftype="gff3" file="b_2_fna_ref_mincov_2_minqual_60.snps.gff" />
feb7e635c6af planemo upload commit f7ba9aa90e952d0639fba2cf6674bb4a7523f308
iuc
parents: 2
diff changeset
211 </test>
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
212 </tests>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
213
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
214
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
215 <help><![CDATA[
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
216
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
217 **Snippy @VERSION@**
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
218
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
219 Snippy finds SNPs between a haploid reference genome and your NGS sequence reads. It will find both substitutions (snps) and insertions/deletions (indels).
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
220
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
221 **Author**
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
222
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
223 Torsten Seemann
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
224
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
225 **Inputs**
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
226
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
227 - NGS Reads in fastq format (single or paired end)
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
228 - Reference file in either fasta or genbank format
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
229
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
230 If the reference file is supplied in genbank format, snpeff will be called to determine the effect of any snps found.
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
231
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
232 **Advanced options**
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
233
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
234 - mapping quality - Integer - Minimum mapping quality to allow (default '60')
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
235
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
236 - minimum coverage - Integer - Minimum coverage of variant site (default '10')
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
237
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
238 - minimum fraction - Float - Minumum proportion for variant evidence (default '0.9')
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
239
2
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
240 - minimum quality - Float - Minumum QUALITY in VCF column 6 (default '100.0')
776ebd1239da planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 1
diff changeset
241
0
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
242 - rgid - String - Use this @RG ID: in the BAM header (default '')
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
243
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
244 - bwaopt - Extra BWA MEM options, eg. -x pacbio (default '')
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
245
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
246 **Further information**
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
247
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
248 For a much more in depth description of snippy and how it works, see https://github.com/tseemann/snippy
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
249
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
250 ]]></help>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
251 <expand macro="citations"/>
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
252
c9a8ef2aa380 planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
253 </tool>