.. aoutools documentation master file, created by
   sphinx-quickstart on Fri Aug  8 15:14:30 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

aoutools: Tools for All of Us Researcher Workbench
=====================================================

aoutools is a Python library designed to simplify common analysis tasks on the
All of Us Researcher Workbench.

.. note::

   **Disclaimer:** This project is **not affiliated with, endorsed by, or
   sponsored by** the *All of Us Research Program*. The software is provided
   **as is**, without warranty. It is in an **early stage of development**, and
   its functions, APIs, and signatures may change periodically.

Overview
--------

aoutools aims to provide a suite of high-level functions designed to make All
of Us data analyses more accessible. The initial release focuses on the
``aoutools.prs`` submodule for calculating Polygenic Risk Scores (PRS).

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation
   guides/index

.. toctree::
   :maxdepth: 2
   :caption: Reference

   api/index