annotate snippy-core.xml @ 22:577b1b17a0ff draft default tip

Added snippy-core tool
author simon-gladman
date Thu, 09 Jun 2016 09:44:50 -0400
parents ebd7a957ff4b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
d1719f16caa3 Added snippy-core tool
simon-gladman
parents: 18
diff changeset
1 <tool id="snippy-core" name="snippy-core" version="0.2.0">
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
2
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
3 <requirements>
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
4 <requirement type="package" version="3.0">snippy</requirement>
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
5 </requirements>
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
6 <stdio>
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
7 <exit_code range="1:" />
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
8 </stdio>
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
9
20
d1a4cfe44743 Added snippy-core tool
simon-gladman
parents: 19
diff changeset
10 <command interpreter="perl">
d1a4cfe44743 Added snippy-core tool
simon-gladman
parents: 19
diff changeset
11 <![CDATA[
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
12
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
13 snippy_core_wrapper.pl
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
14 $is_reference
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
15 --mincov $mincov
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
16 --indirs '${" ".join(map(str, $indirs))}'
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
17
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
18 ]]></command>
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
19
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
20 <inputs>
21
ebd7a957ff4b Added snippy-core tool
simon-gladman
parents: 20
diff changeset
21 <param name="indirs" type="data" multiple="true" format="zip" label="Snippy input zipped dirs" help="Select all the snippy inputs for alignment" />
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
22 <param name="is_reference" type="boolean" checked="true" truevalue="--noref" falsevalue="" label="Exclude reference" help="Don't include the reference file in the alignment." />
22
577b1b17a0ff Added snippy-core tool
simon-gladman
parents: 21
diff changeset
23 <param name="mincov" type="integer" value="10" min="1" label="Minimum coverage" help="Minimum depth of coverage to consider core (default '10')" />
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
24 </inputs>
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
25
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
26 <outputs>
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
27 <data format="fasta" name="alignment_fasta" label="${tool.name} on ${on_string} core alignment fasta" from_work_dir="core.aln" />
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
28 <data format="tabular" name="alignment_table" label="${tool.name} on ${on_string} core alignment table" from_work_dir="core.tab" />
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
29 <data format="txt" name="alignment_summary" label="${tool.name} on ${on_string} core alignment summary" from_work_dir="core.txt" />
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
30 </outputs>
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
31
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
32 <help><![CDATA[
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
33 Synopsis:
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
34 Combine multiple Snippy folders into a core SNP alignment
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
35
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
36 Usage:
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
37 ../../snippy/bin/snippy-core [options] [--noref] snippyDir1/ snippyDir2/ snippyDir3/ ...
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
38
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
39 Options:
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
40
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
41 --help! This help.
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
42
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
43 --quiet! No output to stderr (default '0').
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
44
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
45 --verbose! Verbose output (default '0').
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
46
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
47 --inprefix=s Preferred input prefix of Snippy files (default 'snps').
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
48
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
49 --prefix=s Output file prefix (default 'core').
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
50
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
51 --noref! Exclude reference (default '0').
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
52
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
53 --mincov=i Minimum depth of coverage to consider core (default '10').
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
54
13
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
55 --aformat=s Output alignment format: nexus fasta phylip maf clustalw ... (default 'fasta').
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
56
259aa64b2c99 Updated to new version of snippy with static binaries
simon-gladman
parents:
diff changeset
57 ]]></help>
18
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
58
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
59 <citations>
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
60 <citation type="bibtex">@UNPUBLISHED{Seemann2013,
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
61 author = "Seemann T",
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
62 title = "snippy: fast bacterial variant calling from NGS reads",
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
63 year = "2015",
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
64 note = "https://github.com/tseemann/snippy"}</citation>
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
65 </citations>
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
66
bcb74072d3a6 Added snippy-core tool
simon-gladman
parents: 13
diff changeset
67 </tool>