.. rfmix-reader documentation master file, created by
   sphinx-quickstart on Sun Jun  2 10:18:34 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to rfmix-reader's documentation!
========================================

`rfmix-reader` is a Python package designed to efficiently read and process
output files generated by RFMix, a popular tool for estimating local ancestry in
admixed populations. The package employs a lazy loading approach, which minimizes
memory consumption by reading only the loci that are accessed by the user, rather
than loading the entire dataset into memory at once.

.. toctree::
   :maxdepth: 2
   :caption: Table of Contents

   install
   usage
   api

********
Citation
********

If using, please cite the following pre-print:

Kynon JM Benjamin. "RFMix-reader: Accelerated reading and processing for
local ancestry studies." *bioRxiv*. 2024.
DOI: `10.1101/2024.07.13.603370 <https://www.biorxiv.org/content/10.1101/2024.07.13.603370v2>`_

*****************
Comments and bugs
*****************

You can get the source code and open issues `on Github.`_

.. _on Github.: https://github.com/heart-gen/rfmix_reader

Indices and tables
==================
* :ref:`genindex`
* :ref:`search`