Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
61 lines (39 sloc) 1.37 KB

Welcome

peppy is a python package that provides an API for handling standardized project and sample metadata. If you define your project as a standard Portable Encapsulated Project (or PEP), you can use the peppy package to instantiate an in-memory representation of your project and all of its samples. You can then use this for interactive analysis, or to develop a novel python tool based on peppy so you don't have to handle sample processing.

peppy is primarily useful to tool developers and data analysts who want a standard way of representing sample-intensive research project metadata. To get started, proceed with the :doc:`Introduction <intro>`.

Contents

.. toctree::
        :caption: Explanation and Getting Started
        :maxdepth: 1

        intro.rst
        hello-world.rst
        .. tutorials.rst

.. toctree::
        :maxdepth: 2
        :caption: Tutorials and How-to recipes

        jupyter/tutorial.ipynb
        jupyter/subannotation.ipynb
        models.rst

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

        api.rst



.. toctree::
        :caption: Further Reading
        :maxdepth: 1

        .. faq.rst
        changelog.rst
        support.rst





Indices and tables

Links