.. gendata documentation master file, created by
   sphinx-quickstart on Mon Apr 15 20:17:09 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to gendata's documentation!
===================================

**gendata** is a package that provides an API for reading and operating on genetic data in python. It is capable of loading genetic data in `PLINK's <https://www.cog-genomics.org/plink/1.9/>`_ `bed/bim/fam <https://www.cog-genomics.org/plink/1.9/input>`_ format, performing simple operations on this genetic data, and saving genetic data objects to bed/bim/fam file format.

Check out the :doc:`usage` section for further information.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Contents
========

.. toctree::

   usage
   api

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`