Mercurial > repos > iuc > snippy

annotate snippy-core.xml @ 7:493a80c7107e draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit 1235e6893a7e0d9ea3a600204c515fec1810dd93"
author iuc
date Mon, 04 Nov 2019 20:06:23 -0500
parents f9d3b5a6ef31
children 43791d945de1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
5
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
2 <tool id="snippy_core" name="snippy-core" version="@VERSION@+galaxy0">
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
3 <description>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
4 Combine multiple Snippy outputs into a core SNP alignment
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
5 </description>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
6 <macros>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
7 <import>macros.xml</import>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
8 </macros>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
9 <expand macro="requirements" />
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
5
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
11 @REFERENCE_SOURCE_FILE@
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
12 #for $indir in $indirs
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
13 #set $sample_name = os.path.splitext(os.path.basename(str($indir.name)))[0]
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
14 mkdir '$sample_name' && tar -xf '$indir' -C '$sample_name' --strip-components=1 &&
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
15 #end for
4
98413117ca70 planemo upload commit b5890b40c257a093ebf358294544aa69087da51e
iuc
parents: 2
diff changeset
16 #set snippy_dirs = " ".join(["'{0}'".format(os.path.splitext(os.path.basename(str($indir.name)))[0]) for $indir in $indirs])
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
17 snippy-core
5
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
18 @REFERENCE_COMMAND@
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
19 ${snippy_dirs}
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
20 ]]></command>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
21
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
22 <inputs>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
23 <param name="indirs" type="data" multiple="true" format="zip" label="Snippy input zipped dirs" help="Select all the snippy inputs for alignment" />
5
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
24 <expand macro="reference_selector" />
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
25 <param name="outputs" type="select" multiple="true" display="checkboxes" label="Output selection">
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
26 <option value="outaln" selected="True">A core SNP alignment in the fasta format</option>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
27 <option value="outfull" selected="False">A whole genome SNP alignment (includes invariant sites)</option>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
28 <option value="outtab" selected="False">Tab-separated columnar list of core SNP sites with alleles and annotations</option>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
29 <option value="outtxt" selected="False">Tab-separated columnar list of alignment/core-size statistics</option>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
30 </param>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
31
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
32 </inputs>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
33
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
34 <outputs>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
35 <data format="fasta" name="alignment_fasta" label="${tool.name} on ${on_string} core alignment fasta" from_work_dir="core.aln">
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
36 <filter>outputs and 'outaln' in outputs</filter>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
37 </data>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
38 <data format="fasta" name="full_alignment_fasta" label="${tool.name} on ${on_string} full alignment fasta" from_work_dir="core.full.aln">
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
39 <filter>outputs and 'outfull' in outputs</filter>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
40 </data>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
41 <data format="tabular" name="alignment_table" label="${tool.name} on ${on_string} core alignment table" from_work_dir="core.tab">
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
42 <filter>outputs and 'outtab' in outputs</filter>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
43 </data>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
44 <data format="txt" name="alignment_summary" label="${tool.name} on ${on_string} core alignment summary" from_work_dir="core.txt">
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
45 <filter>outputs and 'outtxt' in outputs</filter>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
46 </data>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
47 </outputs>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
48
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
49 <tests>
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
50 <test><!-- Test #1 - test with 3 zipped directories -->
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
51 <param name="indirs" value="a.tgz,b.tgz,c.tgz" />
5
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
52 <conditional name="reference_source">
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
53 <param name="reference_source_selector" value="history"/>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
54 <param name="ref_file" value="reference.fasta" ftype="fasta"/>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
55 </conditional>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
56 <param name="outputs" value="outtxt" />
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
57 <output name="alignment_summary" ftype="txt" file="a_b_c.core.txt" />
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
58 </test>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
59 <test><!-- Test #2 - test with 3 zipped directories -->
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
60 <param name="indirs" value="a.tgz,b.tgz,c.tgz" />
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
61 <conditional name="reference_source">
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
62 <param name="reference_source_selector" value="cached"/>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
63 <param name="ref_file" value="test_id"/>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
64 </conditional>
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
65 <param name="outputs" value="outtxt" />
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
66 <output name="alignment_summary" ftype="txt" file="a_b_c.core.txt" />
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
67 </test>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
68 </tests>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
69
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
70 <help><![CDATA[
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
71 **snippy-core @VERSION@**
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
72
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
73 Combine multiple Snippy outputs into a core SNP alignment
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
74
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
75 If you call SNPs for multiple isolates from the same reference, you can produce an alignment of "core SNPs" which can be used to build a high-resolution phylogeny (ignoring possible recombination). A "core site" is a genomic position that is present in all the samples. A core site can have the same nucleotide in every sample ("monomorphic") or some samples can be different ("polymorphic" or "variant"). If we ignore the complications of "ins", "del" variant types, and just use variant sites, these are the "core SNP genome".
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
76
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
77
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
78 **Inputs:**
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
79
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
80 Multiple Snippy output directories. (At least 2 of)
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
81
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
82 **Options:**
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
83
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
84 - noreference Exclude reference (default '0').
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
85
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
86 **Note:**
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
87
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
88 snippy **must** have been run with --cleanup False
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
89
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
90 ]]></help>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
91 <expand macro="citations" />
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
92 </tool>