Mercurial > repos > iuc > snippy

annotate snippy-core.xml @ 16:cfbd9a5694ff draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit bc5bbb26c53bf2455043cf4b8f552571e6f74530
author iuc
date Mon, 20 Jan 2025 10:09:34 +0000
parents b23add4731b4
children
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"?>
13
bd61e60350fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 7dec701af24e00b3328459f0a823eefd461237bb"
iuc
parents: 12
diff changeset
2 <tool id="snippy_core" name="snippy-core" version="@WRAPPER_VERSION@+galaxy@VERSION_SUFFIX@">
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>
15
b23add4731b4 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 13
diff changeset
6 <expand macro="bio_tools"/>
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
7 <macros>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
8 <import>macros.xml</import>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
9 </macros>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
10 <expand macro="requirements" />
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
5
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
12 @REFERENCE_SOURCE_FILE@
10
a3f95a688c47 "planemo upload commit 02413e02c9484cdb604bda2c09931599f9259792"
iuc
parents: 9
diff changeset
13 mkdir 'snippy_dirs' && cd 'snippy_dirs' &&
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
14 #for $indir in $indirs
10
a3f95a688c47 "planemo upload commit 02413e02c9484cdb604bda2c09931599f9259792"
iuc
parents: 9
diff changeset
15 tar -xf '$indir' -C . &&
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
16 #end for
10
a3f95a688c47 "planemo upload commit 02413e02c9484cdb604bda2c09931599f9259792"
iuc
parents: 9
diff changeset
17 cd - &&
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
18 snippy-core
5
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
19 @REFERENCE_COMMAND@
10
a3f95a688c47 "planemo upload commit 02413e02c9484cdb604bda2c09931599f9259792"
iuc
parents: 9
diff changeset
20 snippy_dirs/*
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
21 ]]></command>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
22
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
23 <inputs>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
24 <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
25 <expand macro="reference_selector" />
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
26 <param name="outputs" type="select" multiple="true" display="checkboxes" label="Output selection">
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
27 <option value="outaln" selected="True">A core SNP alignment in the fasta format</option>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
28 <option value="outfull" selected="False">A whole genome SNP alignment (includes invariant sites)</option>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
29 <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
30 <option value="outtxt" selected="False">Tab-separated columnar list of alignment/core-size statistics</option>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
31 </param>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
32
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
33 </inputs>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
34
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
35 <outputs>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
36 <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
37 <filter>outputs and 'outaln' in outputs</filter>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
38 </data>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
39 <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
40 <filter>outputs and 'outfull' in outputs</filter>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
41 </data>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
42 <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
43 <filter>outputs and 'outtab' in outputs</filter>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
44 </data>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
45 <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
46 <filter>outputs and 'outtxt' in outputs</filter>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
47 </data>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
48 </outputs>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
49
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
50 <tests>
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
51 <test><!-- Test #1 - test with 3 zipped directories -->
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
52 <param name="indirs" value="a.tgz,b.tgz,c.tgz" />
5
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
53 <conditional name="reference_source">
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
54 <param name="reference_source_selector" value="history"/>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
55 <param name="ref_file" value="reference.fasta" ftype="fasta"/>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
56 </conditional>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
57 <param name="outputs" value="outtxt" />
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
58 <output name="alignment_summary" ftype="txt" file="a_b_c.core.txt" />
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
59 </test>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
60 <test><!-- Test #2 - test with 3 zipped directories -->
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
61 <param name="indirs" value="a.tgz,b.tgz,c.tgz" />
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
62 <conditional name="reference_source">
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
63 <param name="reference_source_selector" value="cached"/>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
64 <param name="ref_file" value="test_id"/>
f9d3b5a6ef31 "planemo upload commit b436c43bb4e8f28c91434173f1b8cb9b187056b2"
iuc
parents: 4
diff changeset
65 </conditional>
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
66 <param name="outputs" value="outtxt" />
2
4eb9595bff60 planemo upload commit dcedcb76831fd639d1468a308a78ac359ecd2496
iuc
parents: 0
diff changeset
67 <output name="alignment_summary" ftype="txt" file="a_b_c.core.txt" />
0
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
68 </test>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
69 </tests>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
70
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
71 <help><![CDATA[
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
72 **snippy-core @VERSION@**
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
73
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
74 Combine multiple Snippy outputs into a core SNP alignment
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
75
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
76 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
77
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
78
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
79 **Inputs:**
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
80
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
81 Multiple Snippy output directories. (At least 2 of)
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
82
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
83 **Options:**
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
84
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
85 - noreference Exclude reference (default '0').
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
86
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
87 **Note:**
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
88
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
89 snippy **must** have been run with --cleanup False
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
90
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
91 ]]></help>
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
92 <expand macro="citations" />
ff177a01b5ca planemo upload commit b288d4f48e58e291bda17c5945c281348ee072c7
iuc
parents:
diff changeset
93 </tool>