Mercurial > repos > galaxytrakr > mitokmer

annotate mitokmer.xml @ 7:56b71adcaba7 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit acd0f9df0a6b4aacd9c53c73e3b8e94dd36ee3dc
author galaxytrakr
date Tue, 15 Sep 2026 22:25:19 +0000
parents e4d4fc748584
children 2b1f3db24c25
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
56b71adcaba7 planemo upload commit acd0f9df0a6b4aacd9c53c73e3b8e94dd36ee3dc
galaxytrakr
parents: 6
diff changeset
1 <tool id="mitokmer" name="mitoKmer" version="2.0+galaxy0.23" profile="21.05">
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
2 <description>Identify metagenomic mitochondrial reads by k-mer database matching</description>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
3 <requirements>
4
ecf96ad08611 planemo upload commit 26a6ad9e9ae7fdb967832a65f5173ea347da7f6c
galaxytrakr
parents: 2
diff changeset
4 <container type="docker">quay.io/galaxytrakr/mitokmer:e57a559</container>
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
5 </requirements>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
6
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
8 #import re
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
9 #def fix_ext($ext):
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
10 #set ext = $ext.replace('fastqsanger', 'fastq')
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
11 #set ext = $ext.replace('fastqillumina', 'fastq')
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
12 #return $ext
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
13 #end def
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
14
2
dd206296acbf planemo upload commit 83cba09882dc583100b39b69b41cf791e4efb55a
galaxytrakr
parents: 1
diff changeset
15 mkdir -p ./mitochondria7 ./jobs7m &&
dd206296acbf planemo upload commit 83cba09882dc583100b39b69b41cf791e4efb55a
galaxytrakr
parents: 1
diff changeset
16
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
17 ## ── Link database files into working directory ────────────────────────
2
dd206296acbf planemo upload commit 83cba09882dc583100b39b69b41cf791e4efb55a
galaxytrakr
parents: 1
diff changeset
18 ln -sf '${probe_db.fields.path}'/* ./mitochondria7/ &&
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
19
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
20 ## ── Symlink kmerread7 binary into working directory ───────────────────
2
dd206296acbf planemo upload commit 83cba09882dc583100b39b69b41cf791e4efb55a
galaxytrakr
parents: 1
diff changeset
21 ln -sf /usr/local/bin/kmerread7 ./kmerread7 &&
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
22
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
23 ## ── Stage input reads and build jobs file ────────────────────────────
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
24 #if $reads.reads_type == "single"
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
25 mkdir -p ./reads &&
7
56b71adcaba7 planemo upload commit acd0f9df0a6b4aacd9c53c73e3b8e94dd36ee3dc
galaxytrakr
parents: 6
diff changeset
26 #set sample_name = re.sub('[^\w\-_.]', '_', $reads.input.name)
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
27 #set read_count = 0
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
28 #for $read in $reads.input
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
29 #set ext = $fix_ext($read.ext)
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
30 #set fname = re.sub('[^\w\-_.]', '_', $read.element_identifier) + '.' + $ext
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
31 ln -sf '$read' './reads/${fname}' &&
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
32 #set read_count = $read_count + 1
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
33 #end for
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
34 printf '%s\t%d\n' '${sample_name}' ${read_count} > ./jobs7m/jobs7m.txt &&
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
35 #for $read in $reads.input
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
36 #set ext = $fix_ext($read.ext)
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
37 #set fname = re.sub('[^\w\-_.]', '_', $read.element_identifier) + '.' + $ext
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
38 printf '%s\n' './reads/${fname}' >> ./jobs7m/jobs7m.txt &&
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
39 #end for
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
40 #else
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
41 ## paired collection: forward + reverse
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
42 mkdir -p ./reads &&
7
56b71adcaba7 planemo upload commit acd0f9df0a6b4aacd9c53c73e3b8e94dd36ee3dc
galaxytrakr
parents: 6
diff changeset
43 #set sample_name = re.sub('[^\w\-_.]', '_', $reads.input.name)
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
44 #set fwd_ext = $fix_ext($reads.input.forward.ext)
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
45 #set rev_ext = $fix_ext($reads.input.reverse.ext)
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
46 #set base = re.sub('[^\w\-_.]', '_', $reads.input.element_identifier)
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
47 #set fwd_fname = $base + '_1.' + $fwd_ext
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
48 #set rev_fname = $base + '_2.' + $rev_ext
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
49 ln -sf '$reads.input.forward' './reads/${fwd_fname}' &&
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
50 ln -sf '$reads.input.reverse' './reads/${rev_fname}' &&
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
51 printf '%s\t2\n' '${sample_name}' > ./jobs7m/jobs7m.txt &&
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
52 printf '%s\n' './reads/${fwd_fname}' >> ./jobs7m/jobs7m.txt &&
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
53 printf '%s\n' './reads/${rev_fname}' >> ./jobs7m/jobs7m.txt &&
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
54 #end if
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
55
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
56 ## ── Run the Python orchestrator ───────────────────────────────────────
2
dd206296acbf planemo upload commit 83cba09882dc583100b39b69b41cf791e4efb55a
galaxytrakr
parents: 1
diff changeset
57 python3 /opt/mitokmer2/kmer_read_m7.py &&
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
58
2
dd206296acbf planemo upload commit 83cba09882dc583100b39b69b41cf791e4efb55a
galaxytrakr
parents: 1
diff changeset
59 ## ── Copy output CSV to Galaxy output path ─────────────────────────────
dd206296acbf planemo upload commit 83cba09882dc583100b39b69b41cf791e4efb55a
galaxytrakr
parents: 1
diff changeset
60 cp ./jobs7m/jobs7m.csv '${results_csv}'
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
61 ]]></command>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
62
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
63 <inputs>
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
64 <param name="probe_db" type="select" label="Mitochondrial k-mer probe database"
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
65 help="Select a pre-installed mitochondrial k-mer probe database.
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
66 Databases are managed by your Galaxy administrator via the
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
67 mitokmer_probe_db data table.">
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
68 <options from_data_table="mitokmer_probe_db">
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
69 <filter type="sort_by" column="1" />
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
70 <validator type="no_options" message="No mitochondrial k-mer probe databases are
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
71 currently installed. Please contact your Galaxy administrator." />
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
72 </options>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
73 </param>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
74
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
75 <conditional name="reads">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
76 <param name="reads_type" type="select" label="Input read type">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
77 <option value="single">Single-end or unpaired reads / FASTA (list collection)</option>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
78 <option value="paired">Paired-end reads (paired collection)</option>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
79 </param>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
80 <when value="single">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
81 <param name="input" type="data_collection" collection_type="list"
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
82 format="fastqsanger,fastqsanger.gz,fastqillumina,fastqillumina.gz,fasta,fasta.gz"
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
83 label="Input reads (FASTQ or FASTA, gzipped or plain)"
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
84 help="Provide one or more single-end or unpaired read files as a Galaxy
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
85 list collection. For paired-end data, use the 'Paired-end reads'
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
86 option instead." />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
87 </when>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
88 <when value="paired">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
89 <param name="input" type="data_collection" collection_type="paired"
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
90 format="fastqsanger,fastqsanger.gz,fastqillumina,fastqillumina.gz"
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
91 label="Paired-end reads (paired collection)"
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
92 help="Provide a Galaxy paired collection containing forward (R1) and
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
93 reverse (R2) reads. Light quality trimming of read ends is
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
94 performed internally; pre-trimming is optional." />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
95 </when>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
96 </conditional>
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
97 </inputs>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
98
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
99 <outputs>
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
100 <data name="results_csv" format="csv" label="mitoKmer results for ${on_string}" />
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
101 </outputs>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
102
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
103 <tests>
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
104 <!-- Test 1: paired-end FASTQ via paired collection -->
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
105 <test>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
106 <param name="probe_db" value="mitoch_probes_sample" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
107 <conditional name="reads">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
108 <param name="reads_type" value="paired" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
109 <param name="input">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
110 <collection type="paired">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
111 <element name="forward" value="test/Plodia_R1.fastq.gz" ftype="fastqsanger.gz" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
112 <element name="reverse" value="test/Plodia_R2.fastq.gz" ftype="fastqsanger.gz" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
113 </collection>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
114 </param>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
115 </conditional>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
116 <output name="results_csv">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
117 <assert_contents>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
118 <has_text text="Plodia" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
119 </assert_contents>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
120 </output>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
121 </test>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
122 <!-- Test 2: single-end FASTQ via list collection -->
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
123 <test>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
124 <param name="probe_db" value="mitoch_probes_sample" />
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
125 <conditional name="reads">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
126 <param name="reads_type" value="single" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
127 <param name="input">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
128 <collection type="list">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
129 <element name="Plodia_R1" value="test/Plodia_R1.fastq.gz" ftype="fastqsanger.gz" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
130 </collection>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
131 </param>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
132 </conditional>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
133 <output name="results_csv">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
134 <assert_contents>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
135 <has_text text="Plodia" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
136 </assert_contents>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
137 </output>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
138 </test>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
139 <!-- Test 3: single FASTA via list collection -->
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
140 <test>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
141 <param name="probe_db" value="mitoch_probes_sample" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
142 <conditional name="reads">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
143 <param name="reads_type" value="single" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
144 <param name="input">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
145 <collection type="list">
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
146 <element name="Plodia_assembly" value="test/Plodia_assembly.fasta" ftype="fasta" />
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
147 </collection>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
148 </param>
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
149 </conditional>
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
150 <output name="results_csv">
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
151 <assert_contents>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
152 <has_text text="Plodia" />
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
153 </assert_contents>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
154 </output>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
155 </test>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
156 </tests>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
157
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
158 <help><![CDATA[
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
159 **mitoKmer** — Metagenomic Mitochondrial Read Identification by K-mer Database
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
160 ===============================================================================
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
161
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
162 Overview
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
163 --------
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
164 mitoKmer identifies the taxonomic origin of short-read shotgun sequencing data
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
165 by matching reads against a database of species-specific mitochondrial k-mer
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
166 probes. It reports the relative abundance of taxa at multiple taxonomic ranks
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
167 (e.g. order, species) along with the number of matching reads and supporting
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
168 unique k-mers.
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
169
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
170 Inputs
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
171 ------
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
172 **Mitochondrial k-mer probe database**
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
173 Select a pre-installed probe database from the dropdown. Databases are
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
174 managed by your Galaxy administrator and registered in the
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
175 ``mitokmer_probe_db`` data table. The database consists of a directory
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
176 of ``.txt`` files.
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
177
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
178 **Input read type**
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
179 Choose the input mode that matches your data:
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
180
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
181 *Single-end or unpaired reads / FASTA (list collection)*
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
182 Provide a Galaxy **list** collection containing one or more FASTQ
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
183 (``fastqsanger``, ``fastqsanger.gz``) or FASTA (``fasta``,
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
184 ``fasta.gz``) files. Use this for single-end sequencing data or
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
185 assembled FASTA sequences.
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
186
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
187 *Paired-end reads (paired collection)*
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
188 Provide a Galaxy **paired** collection where the forward (R1) and
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
189 reverse (R2) reads are paired together. Both files must be FASTQ
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
190 format (``fastqsanger`` or ``fastqsanger.gz``).
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
191
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
192 In all cases, light window-based quality trimming of read ends is
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
193 performed internally; pre-trimming is optional.
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
194
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
195 Output
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
196 ------
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
197 **Results CSV**
5
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
198 A comma-separated file with one row per taxon detected. Columns:
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
199
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
200 ========= ============================================================
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
201 Column Description
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
202 ========= ============================================================
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
203 Rank Taxonomic rank (e.g. Order, Species)
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
204 Taxon Taxon name
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
205 Reads Number of reads matching this taxon
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
206 Rel_Abund Relative abundance (%)
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
207 Unique_kmers Number of unique k-mers supporting the match
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
208 ========= ============================================================
8f4abeb27625 planemo upload commit 3118e6e386354d664c85c47c67b75a92629d358c
galaxytrakr
parents: 4
diff changeset
209
2
dd206296acbf planemo upload commit 83cba09882dc583100b39b69b41cf791e4efb55a
galaxytrakr
parents: 1
diff changeset
210 Only taxa with non-zero relative abundance are reported.
0
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
211
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
212 Example output for the "Plodia" test sample::
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
213
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
214 Rank Taxon Reads Rel_Abund(%) Unique_kmers
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
215 Order Lepidoptera 10 0.1 329
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
216 Species Plodia interpunctella 462 99.9 466
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
217
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
218 Citation
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
219 --------
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
220 Please cite the mitoKmer GitHub repository if you use this tool in published work.
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
221 ]]></help>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
222
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
223 <citations>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
224 <citation type="bibtex">
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
225 @misc{githubmitokmer2,
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
226 author = {Mammel, Mark},
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
227 title = {mitoKmer2},
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
228 year = {2024},
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
229 publisher = {GitHub},
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
230 journal = {GitHub repository},
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
231 url = {https://github.com/mmammel8/mitokmer2},
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
232 }
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
233 </citation>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
234 </citations>
adc887a1a6de planemo upload commit 927c4ee71df7d19ceb10446a04618af22c99d839
galaxytrakr
parents:
diff changeset
235 </tool>