Skip to content
Permalink
Browse files

Add mkdocs draft

  • Loading branch information...
nsheff committed Jan 4, 2019
1 parent c8dd7c8 commit 5b7ea9c1d7891375017381c23576557581a7959c
@@ -0,0 +1,6 @@
# peppy

`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 <http://pepkit.github.io/>`_ (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>`.

0 comments on commit 5b7ea9c

Please sign in to comment.
You can’t perform that action at this time.