summaryrefslogtreecommitdiffstats
path: root/academic/jellyfish_k-mer/README
diff options
context:
space:
mode:
Diffstat (limited to 'academic/jellyfish_k-mer/README')
-rw-r--r--academic/jellyfish_k-mer/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/academic/jellyfish_k-mer/README b/academic/jellyfish_k-mer/README
new file mode 100644
index 0000000000..7988cded9c
--- /dev/null
+++ b/academic/jellyfish_k-mer/README
@@ -0,0 +1,12 @@
+Jellyfish is a tool for fast, memory-efficient counting of k-mers in
+DNA. A k-mer is a substring of length k, and counting the occurrences of
+all such substrings is a central step in many analyses of DNA sequence.
+Jellyfish can count k-mers quickly by using an efficient encoding of a
+hash table and by exploiting the "compare-and-swap" CPU instruction to
+increase parallelism.
+
+Jellyfish is a command-line program that reads FASTA and multi-FASTA
+files containing DNA sequences. It outputs its k-mer counts in an binary
+format, which can be translated into a human-readable text format using
+the "jellyfish dump" command. See the documentation below for more
+details.