Skip to content

Documentation for kmer-ord

Documentation is still under development, bare with us

This documentation describes the kmer-ord toolkit for computing, normalising, and ordinating k-mer count data for exploratory analysis of long-read sequencing datasets or assembled contigs.

The workflow consists of:

  • Generating k-mer count matrices
  • Preprocessing the count matrix with appropriate normalisation for compositional data
  • Performing dimensionality reduction
  • Inspecting embeddings structure and binning

Documentation structure

  • Getting started


    Install dependencies and set up environment

    Installation

    Quickstart

  • Reference


    Complete command-line and parameter documentation for each script

    Reference

  • Tutorials


    Practical guides for common workflows and analyses Workflows

    Detailed examples Tutorials

  • Concepts


    Background material explaining why certain steps are required and how to interpret results.

    Concepts

    Glossary

    FAQ