Welcome to kMer’s documentation!

kMer is an analysis toolkit and Python programming library for k-mer profiles.

User’s guide

• Introduction
• Installation
  • Dependencies
  • Latest kMer release
  • kMer development version
• Methodology
  • k-mer counting
  • Distance metrics
  • Strand balance
  • Profile shrinking
  • Scaling and smoothing
• Tutorial
  • k-mer counting
  • Merging profiles
  • Distance between profiles
  • Enforcing strand balance
  • Custom merge functions
• Using the Python library
  • k-mer profiles
  • Storing k-mer profiles
  • Differences between k-mer profiles

API reference

• API reference
  • k-mer profiles
  • k-mer profile distances
  • Metrics

Additional notes

• Development
  • Contributing
  • Documentation
  • Unit tests
  • Coding style
  • Versioning
• k-mer profile file format
  • Versioning
  • Current version: 1.0.0
  • Changes from older versions
• Changelog
  • Version 1.0.1
  • Version 1.0.0
  • Version 0.3.0
  • Version 0.2.0
  • Version 0.1.0
• Copyright
  • Authors
  • License

Indices and tables

• Index
• Module Index
• Search Page