annotate snippy-core.xml @ 32:3ac93a6e4687 draft default tip

"planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
author dfornika
date Sat, 25 Jan 2020 00:50:20 +0000
parents 75cfb1377da1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
0bf16c8aca73 planemo upload commit 60e2302cfac90d0c909ef61815aaaafaaad5816a-dirty
dfornika
parents: 20
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
29
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
2 <tool id="snippy_core" name="snippy-core" version="@VERSION@+galaxy1">
0
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
3 <description>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
4 Combine multiple Snippy outputs into a core SNP alignment
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
5 </description>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
6 <macros>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
7 <import>macros.xml</import>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
8 </macros>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
9 <expand macro="requirements" />
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
29
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
11 @REFERENCE_SOURCE_FILE@
31
75cfb1377da1 "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 29
diff changeset
12 mkdir 'snippy_dirs' && cd 'snippy_dirs' &&
22
0bf16c8aca73 planemo upload commit 60e2302cfac90d0c909ef61815aaaafaaad5816a-dirty
dfornika
parents: 20
diff changeset
13 #for $indir in $indirs
31
75cfb1377da1 "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 29
diff changeset
14 tar -xf '$indir' -C . &&
22
0bf16c8aca73 planemo upload commit 60e2302cfac90d0c909ef61815aaaafaaad5816a-dirty
dfornika
parents: 20
diff changeset
15 #end for
31
75cfb1377da1 "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 29
diff changeset
16 cd - &&
22
0bf16c8aca73 planemo upload commit 60e2302cfac90d0c909ef61815aaaafaaad5816a-dirty
dfornika
parents: 20
diff changeset
17 snippy-core
29
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
18 @REFERENCE_COMMAND@
31
75cfb1377da1 "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 29
diff changeset
19 snippy_dirs/*
0
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
20 ]]></command>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
21
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
22 <inputs>
29
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
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" />
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
24 <expand macro="reference_selector" />
0
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
25 <param name="outputs" type="select" multiple="true" display="checkboxes" label="Output selection">
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
26 <option value="outaln" selected="True">A core SNP alignment in the fasta format</option>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
27 <option value="outfull" selected="False">A whole genome SNP alignment (includes invariant sites)</option>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
28 <option value="outtab" selected="False">Tab-separated columnar list of core SNP sites with alleles and annotations</option>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
29 <option value="outtxt" selected="False">Tab-separated columnar list of alignment/core-size statistics</option>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
30 </param>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
31
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
32 </inputs>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
33
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
34 <outputs>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
35 <data format="fasta" name="alignment_fasta" label="${tool.name} on ${on_string} core alignment fasta" from_work_dir="core.aln">
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
36 <filter>outputs and 'outaln' in outputs</filter>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
37 </data>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
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">
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
39 <filter>outputs and 'outfull' in outputs</filter>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
40 </data>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
41 <data format="tabular" name="alignment_table" label="${tool.name} on ${on_string} core alignment table" from_work_dir="core.tab">
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
42 <filter>outputs and 'outtab' in outputs</filter>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
43 </data>
29
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
44 <data format="txt" name="alignment_summary" label="${tool.name} on ${on_string} core alignment summary" from_work_dir="core.txt">
0
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
45 <filter>outputs and 'outtxt' in outputs</filter>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
46 </data>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
47 </outputs>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
48
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
49 <tests>
20
3bbfe41787af planemo upload commit bf653fc1bf39312caf070843fbde7b2570330917-dirty
dfornika
parents: 19
diff changeset
50 <test><!-- Test #1 - test with 3 zipped directories -->
25
ae9dffe91f20 planemo upload commit 976a7fd83686e1fe0e4ca2ee9b7c98fff7241d6d-dirty
dfornika
parents: 24
diff changeset
51 <param name="indirs" value="a.tgz,b.tgz,c.tgz" />
29
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
52 <conditional name="reference_source">
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
53 <param name="reference_source_selector" value="history"/>
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
54 <param name="ref_file" value="reference.fasta" ftype="fasta"/>
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
55 </conditional>
0
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
56 <param name="outputs" value="outtxt" />
29
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
57 <output name="alignment_summary" ftype="txt" file="a_b_c.core.txt" />
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
58 </test>
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
59 <test><!-- Test #2 - test with 3 zipped directories -->
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
60 <param name="indirs" value="a.tgz,b.tgz,c.tgz" />
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
61 <conditional name="reference_source">
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
62 <param name="reference_source_selector" value="cached"/>
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
63 <param name="ref_file" value="test_id"/>
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
64 </conditional>
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
65 <param name="outputs" value="outtxt" />
62329bafeaef "planemo upload commit f1b3e36f79747fca391321389276ac196d3f7cd0-dirty"
dfornika
parents: 28
diff changeset
66 <output name="alignment_summary" ftype="txt" file="a_b_c.core.txt" />
0
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
67 </test>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
68 </tests>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
69
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
70 <help><![CDATA[
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
71 **snippy-core @VERSION@**
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
72
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
73 Combine multiple Snippy outputs into a core SNP alignment
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
74
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
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".
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
76
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
77
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
78 **Inputs:**
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
79
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
80 Multiple Snippy output directories. (At least 2 of)
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
81
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
82 **Options:**
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
83
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
84 - noreference Exclude reference (default '0').
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
85
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
86 **Note:**
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
87
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
88 snippy **must** have been run with --cleanup False
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
89
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
90 ]]></help>
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
91 <expand macro="citations" />
0276bb8bd561 planemo upload for repository https://github.com/tseemann/snippy commit d9e4e18619d5b9378f4fcbe518856fc1fa202d73-dirty
dfornika
parents:
diff changeset
92 </tool>