annotate kmer2stats.xml @ 1:6ae87ffcea01 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
author iuc
date Tue, 22 Apr 2025 11:34:36 +0000
parents a926baa751bf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
1 <tool id="kmer2stats" name="Kmer2Stats" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="24.2">
1
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
2 <description>A tool that computes kmer alpha diversity metrics and other statistics</description>
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
3 <macros>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
4 <token name="@TOOL_VERSION@">1.0.1</token>
1
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
5 <token name="@VERSION_SUFFIX@">1</token>
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
6 </macros>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
7 <requirements>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">kmer2stats</requirement>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
9 </requirements>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
10 <command detect_errors="exit_code">
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
11 <![CDATA[
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
12 kmer2stats.py
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
13 '$input_file'
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
14 &&
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
15 cp 'compute_diversity.csv' '$output_file'
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
16 ]]>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
17 </command>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
18 <inputs>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
19 <param name="input_file" type="data" format="tabular,txt" label="File input"/>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
20 </inputs>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
21 <outputs>
1
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
22 <data name="output_file" format="tabular" label="${tool.name}: kmer statistics"/>
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
23 </outputs>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
24 <tests>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
25 <test expect_num_outputs="1">
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
26 <param name="input_file" ftype="txt" value="test_file.txt"/>
1
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
27 <output name="output_file" ftype="tabular" value="compute_diversity.csv"/>
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
28 </test>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
29 </tests>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
30 <help>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
31 <![CDATA[
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
32
1
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
33 **What this tool does**
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
34
1
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
35 This tool calculates alpha diversity metrics and other statistics such as observed features based on counted kmers.
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
36
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
37 **Input**
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
38
1
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
39 This tool was designed to use the output from jellyfish but it also can take any file that looks like this:
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
40
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
41 ::
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
42
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
43 ANYTHING SINCE THIS LINE WILL ALWAYS BE SKIPPED
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
44 AAAAAA 8453
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
45 AAAAAC 6870
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
46 AAAAAG 6312
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
47 AAAAAT 7966
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
48 AAAACA 5133
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
49 AAAACC 5600
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
50 AAAACG 5870
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
51 AAAACT 3911
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
52 AAAAGA 4173
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
53 AAAAGC 5078
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
54 AAAAGG 3047
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
55 AAAAGT 3067
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
56 AAAATA 5726
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
57 AAAATC 6167
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
58 AAAATG 5731
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
59 AAAATT 4987
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
60 AAACAA 3719
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
61 AAACAC 2817
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
62 AAACAG 5565
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
63
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
64 The first line will always be skipped so be sure to start the counted kmers in the second row!
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
65
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
66 **Output**
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
67
1
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
68 Two column table with metric name in the first column and value in second column.
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
69
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
70 ::
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
71
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
72 Metric Value
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
73 shannon 3.0008343481203097
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
74 simpson_d 0.05166872360281036
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
75 pielou_e 0.9856502651904311
6ae87ffcea01 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
76
0
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
77 ]]>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
78 </help>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
79 <citations>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
80 <citation type="bibtex">@misc{BibEntry2025Apr,
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
81 title = {{kmer2stats}},
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
82 author = {Santino Faack (SantaMcCloud)},
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
83 journal = {GitHub},
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
84 year = {2025},
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
85 month = apr,
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
86 url = {https://github.com/SantaMcCloud/kmer2stats}
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
87 }</citation>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
88 </citations>
a926baa751bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
89 </tool>