.. newmap documentation master file, created by
   sphinx-quickstart on Fri Jul 19 15:19:57 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Newmap documentation
====================

**Newmap** is a set of tools for quantifying mappability for any sequence.
Newmap records mers of length *k* if *k* is unique across the entire sequence.
From these unique lengths, at given length *k*, Newmap can then output a
single-read mappability Browser Extensible Data (BED) file and a multi-read
mappability Wiggle file.

Contents
--------
.. toctree::

    usage
    commands
    unique_format
    umap
    credits