Metadata-Version: 2.1
Name: gpmap
Version: 0.7.0
Summary: A Python API for managing genotype-phenotype map data
Home-page: https://github.com/harmslab/gpmap
Author: Zachary R. Sailer
Author-email: zachsailer@gmail.com
License: MIT
Description: 
        
        # GPMap
        
        [![Join the chat at https://gitter.im/harmslab/gpmap](https://badges.gitter.im/harmslab/gpmap.svg)](https://gitter.im/harmslab/gpmap?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
        [![Documentation Status](https://readthedocs.org/projects/gpmap/badge/?version=latest)](http://gpmap.readthedocs.io/en/latest/?badge=latest)
        [![Build Status](https://travis-ci.org/harmslab/gpmap.svg?branch=master)](https://travis-ci.org/harmslab/gpmap)
        
        *A Python API for managing genotype-phenotype map data*
        
        GPMap defines a flexible object for managing genotype-phenotype (GP) map data. At it's core,
        it stores all data in Pandas DataFrames and thus, interacts seamlessly with the
        PyData egosystem.
        
        To visualize genotype-phenotype objects created by GPMap, checkout [GPGraph](https://github.com/Zsailer/gpgraph).
        
        <img src="docs/_img/gpm.png"> <img src="docs/_img/dataframe.png" width="400">
        
        ## Basic example
        
        Import the package's base object.
        ```python
        from gpmap import GenotypePhenotypeMap
        ```
        
        Pass your data to the object.
        ```python
        
        # Data
        wildtype = "AAA"
        genotypes = ["AAA", "AAT", "ATA", "TAA", "ATT", "TAT", "TTA", "TTT"]
        phenotypes = [0.1, 0.2, 0.2, 0.6, 0.4, 0.6, 1.0, 1.1]
        stdeviations = [0.05, 0.05, 0.05, 0.05, 0.05, 0.05, 0.05, 0.05]
        
        # Initialize the object
        gpm = GenotypePhenotypeMap(wildtype,
                                   genotypes,
                                   phenotypes,
                                   stdeviations=stdeviations)
        
        # Check out the data.
        gpm.data
        ```
        <img src="docs/_img/dataframe.png" width="350">
        
        
        Or load a dataset from disk.
        ```python
        gpm = GenotypePhenotypeMap.read_json("data.json")
        ```
        
        ## Installation
        
        **Users**
        This simplest way to install this package is using pip:
        ```
        pip install gpmap
        ```
        
        **Developers**
        The recommended way to install this package for development is using `pipenv`.
        
        1. Clone this repository:
        ```
        git clone https://github.com/harmslab/gpmap
        ```
        2. Install the package using pipenv.
        ```
        cd gpmap
        pipenv install --dev -e .
        ```
        3. Run tests using pytest
        ```
        pytest
        ```
        
        ## Dependencies
        
        The following modules are required. Also, the examples/tutorials are written in Jupyter notebooks and require IPython to be installed.
        
        * [Numpy](http://www.numpy.org/)
        * [Pandas](https://pandas.pydata.org/)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.3.0
Description-Content-Type: text/markdown
