.. image:: ../assets/index/gfastar_logo_thumbnail.png
  :width: 200
  :alt: gfastar logo
  :align: center

Welcome to rdeval's documentation!
===================================

**rdeval** is a tool to efficiently generate and visualize summary statistics for sequence data.

Check out the :doc:`usage` section for further information, including
how to :ref:`installation <Installation>` the project.
A description of rdeval's .rd file format can be found in the :doc:`format specification section <format_specification>`.

.. note::

   rdeval's source code is available `here <https://github.com/vgl-hub/rdeval>`_.

Contents
--------

.. toctree::

   usage
   rd
   cifi
   format_specification
   efficiency_considerations