annotate kmer2stats.xml @ 1:ee32f1a3b2a7 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:43 +0000
parents 6150c3b0a1eb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6150c3b0a1eb 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
ee32f1a3b2a7 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
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
3 <macros>
6150c3b0a1eb 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
ee32f1a3b2a7 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
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
6 </macros>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
7 <requirements>
6150c3b0a1eb 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>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
9 </requirements>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
10 <command detect_errors="exit_code">
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
11 <![CDATA[
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
12 kmer2stats.py
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
13 '$input_file'
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
14 &&
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
15 cp 'compute_diversity.csv' '$output_file'
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
16 ]]>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
17 </command>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
18 <inputs>
6150c3b0a1eb 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"/>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
20 </inputs>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
21 <outputs>
1
ee32f1a3b2a7 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
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
23 </outputs>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
24 <tests>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
25 <test expect_num_outputs="1">
6150c3b0a1eb 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
ee32f1a3b2a7 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
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
28 </test>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
29 </tests>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
30 <help>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
31 <![CDATA[
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
32
1
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
33 **What this tool does**
0
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
34
1
ee32f1a3b2a7 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
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
36
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
37 **Input**
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
38
1
ee32f1a3b2a7 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
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
40
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
41 ::
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
42
6150c3b0a1eb 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
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
44 AAAAAA 8453
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
45 AAAAAC 6870
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
46 AAAAAG 6312
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
47 AAAAAT 7966
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
48 AAAACA 5133
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
49 AAAACC 5600
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
50 AAAACG 5870
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
51 AAAACT 3911
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
52 AAAAGA 4173
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
53 AAAAGC 5078
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
54 AAAAGG 3047
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
55 AAAAGT 3067
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
56 AAAATA 5726
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
57 AAAATC 6167
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
58 AAAATG 5731
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
59 AAAATT 4987
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
60 AAACAA 3719
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
61 AAACAC 2817
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
62 AAACAG 5565
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
63
6150c3b0a1eb 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!
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
65
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
66 **Output**
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
67
1
ee32f1a3b2a7 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.
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
69
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
70 ::
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
71
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
72 Metric Value
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
73 shannon 3.0008343481203097
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
74 simpson_d 0.05166872360281036
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
75 pielou_e 0.9856502651904311
ee32f1a3b2a7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit 069a351be3e6272c2d511c545593f32fd18f8a84
iuc
parents: 0
diff changeset
76
0
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
77 ]]>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
78 </help>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
79 <citations>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
80 <citation type="bibtex">@misc{BibEntry2025Apr,
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
81 title = {{kmer2stats}},
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
82 author = {Santino Faack (SantaMcCloud)},
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
83 journal = {GitHub},
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
84 year = {2025},
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
85 month = apr,
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
86 url = {https://github.com/SantaMcCloud/kmer2stats}
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
87 }</citation>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
88 </citations>
6150c3b0a1eb planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
iuc
parents:
diff changeset
89 </tool>