annotate emmtyper.xml @ 0:e72652c6edb9 draft

Uploaded
author estrain
date Fri, 31 Mar 2023 17:14:38 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
1 l<tool id="emmtyper" name="emm-typing of S. pyogenes" version="0.1.0+galaxy0">
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
2 <requirements>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
3 <requirement type="package">emmtyper</requirement>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
4 </requirements>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
6 emmtyper -o '$output1' '$input1'
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
7 ]]></command>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
8 <inputs>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
9 <param type="data" name="input1" format="fasta" />
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
10 </inputs>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
11 <outputs>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
12 <data name="output1" format="txt" from_work_dir="results.txt" />
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
13 </outputs>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
14 <help><![CDATA[
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
15 Usage: emmtyper [OPTIONS] [FASTA]...
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
16
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
17 Welcome to emmtyper.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
18
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
19 Usage:
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
20
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
21 emmtyper *.fasta
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
22
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
23 Options:
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
24 --version Show the version and exit.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
25 -w, --workflow [blast|pcr] Choose workflow [default: blast]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
26 -d, --blast_db TEXT Path to EMM BLAST DB
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
27 -k, --keep Keep BLAST and isPcr output files.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
28 -d, --cluster-distance INTEGER Distance between cluster of matches to
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
29 consider as different clusters. [default:
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
30 500]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
31 -o, --output TEXT Output stream. Path to file for output to a
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
32 file. [default: stdout]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
33 -f, --output-format [short|verbose|visual]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
34 Output format.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
35 --dust [yes|no|level window linker]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
36 [BLAST] Filter query sequence with DUST.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
37 [default: no]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
38 --percent-identity INTEGER [BLAST] Minimal percent identity of
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
39 sequence. [default: 95]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
40 --culling-limit INTEGER [BLAST] Total hits to return in a position.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
41 [default: 5]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
42 --mismatch INTEGER [BLAST] Threshold for number of mismatch to
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
43 allow in BLAST hit. [default: 4]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
44 --align-diff INTEGER [BLAST] Threshold for difference between
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
45 alignment length and subject length in BLAST
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
46 hit. [default: 5]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
47 --gap INTEGER [BLAST] Threshold gap to allow in BLAST hit.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
48 [default: 2]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
49 --blast-path TEXT [BLAST] Specify full path to blastn
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
50 executable.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
51 --primer-db TEXT [isPcr] PCR primer. Text file with 3
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
52 columns: Name, Forward Primer, Reverse
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
53 Primer.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
54 --min-perfect INTEGER [isPcr] Minimum size of perfect match at 3'
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
55 primer end. [default: 15]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
56 --min-good INTEGER [isPcr] Minimum size where there must be 2
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
57 matches for each mismatch. [default: 15]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
58 --max-size INTEGER [isPcr] Maximum size of PCR product.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
59 [default: 2000]
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
60 --ispcr-path TEXT [isPcr] Specify full path to isPcr
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
61 executable.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
62 --help Show this message and exit.
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
63
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
64 ]]></help>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
65 <citations>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
66 <citation type="bibtex">
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
67 @misc{githubemmtyper,
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
68 author = {LastTODO, FirstTODO},
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
69 year = {TODO},
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
70 title = {emmtyper},
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
71 publisher = {GitHub},
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
72 journal = {GitHub repository},
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
73 url = {https://github.com/MDU-PHL/emmtyper},
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
74 }</citation>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
75 </citations>
e72652c6edb9 Uploaded
estrain
parents:
diff changeset
76 </tool>