annotate emmtyper.xml @ 0:7c4f40e10fb9

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