diff kmer2stats.xml @ 0:6150c3b0a1eb draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/kmer2stats/ commit bd206c6d73970ab185b1c2afe9c1371c96304ba2
author iuc
date Wed, 16 Apr 2025 09:35:28 +0000
parents
children ee32f1a3b2a7
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/kmer2stats.xml	Wed Apr 16 09:35:28 2025 +0000
@@ -0,0 +1,82 @@
+<tool id="kmer2stats" name="Kmer2Stats" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="24.2">
+    <description>A tool for creating data files for statistics based on kmers</description>
+    <macros>
+        <token name="@TOOL_VERSION@">1.0.1</token>
+        <token name="@VERSION_SUFFIX@">0</token>
+    </macros>
+    <requirements>
+        <requirement type="package" version="@TOOL_VERSION@">kmer2stats</requirement>
+    </requirements>
+    <command detect_errors="exit_code">
+    <![CDATA[
+        kmer2stats.py 
+        '$input_file'
+        &&
+        cp 'compute_diversity.csv' '$output_file'
+    ]]>
+    </command>
+    <inputs>
+        <param name="input_file" type="data" format="tabular,txt" label="File input"/> 
+    </inputs>
+    <outputs>
+        <data name="output_file" format="csv" label="${tool.name}: COMPUTED DIVERSITY"/>
+    </outputs>
+    <tests>
+        <test expect_num_outputs="1">
+            <param name="input_file" ftype="txt" value="test_file.txt"/>
+            <output name="output_file" ftype="csv" value="compute_diversity.csv"/>
+        </test>
+    </tests>
+    <help>
+    <![CDATA[
+
+        **What this do**
+
+        This tool calculates diversity based on counted kmers.
+
+        **Input**
+
+        This tool was designed to use the output from jellyfish but it also can take a file which should look like this:
+
+        ::
+
+         ANYTHING SINCE THIS LINE WILL ALWAYS BE SKIPPED
+         AAAAAA 8453
+         AAAAAC 6870
+         AAAAAG 6312
+         AAAAAT 7966
+         AAAACA 5133
+         AAAACC 5600
+         AAAACG 5870
+         AAAACT 3911
+         AAAAGA 4173
+         AAAAGC 5078
+         AAAAGG 3047
+         AAAAGT 3067
+         AAAATA 5726
+         AAAATC 6167
+         AAAATG 5731
+         AAAATT 4987
+         AAACAA 3719
+         AAACAC 2817
+         AAACAG 5565
+
+        The first line will always be skipped so be sure to start the counted kmers in the second row!
+
+        **Output**
+
+        This will be a file where the alpha diversity is calculated and stored as a panda dataframe which then can be used for plotting.
+    
+    ]]>
+    </help>
+    <citations>
+        <citation type="bibtex">@misc{BibEntry2025Apr,
+            title = {{kmer2stats}},
+            author = {Santino Faack (SantaMcCloud)},
+            journal = {GitHub},
+            year = {2025},
+            month = apr,
+            url = {https://github.com/SantaMcCloud/kmer2stats}
+        }</citation>
+    </citations>
+</tool>