Metadata-Version: 1.1
Name: expan
Version: 0.5.0
Summary: Experiment Analysis Library
Home-page: https://github.com/zalando/expan
Author: Zalando SE
Author-email: octopus@zalando.de
License: MIT
Description: ==========================
        ExpAn: Experiment Analysis
        ==========================
        
        .. image:: https://img.shields.io/travis/zalando/expan.svg
                :target: https://travis-ci.org/zalando/expan
                :alt: Build status
        
        .. image:: https://img.shields.io/pypi/v/expan.svg
                :target: https://pypi.python.org/pypi/expan
                :alt: Latest PyPI version
        
        .. image:: https://img.shields.io/pypi/status/expan.svg
           :target: https://pypi.python.org/pypi/expan
           :alt: Development Status
        
        .. image:: https://img.shields.io/pypi/pyversions/expan.svg
           :target: https://pypi.python.org/pypi/expan
           :alt: Python Versions
        
        .. image:: https://img.shields.io/pypi/l/expan.svg
                :target: https://pypi.python.org/pypi/expan/
                :alt: License
        
        .. image:: https://readthedocs.org/projects/expan/badge/?version=latest
                :target: http://expan.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        A/B tests (a.k.a. Randomized Controlled Trials or Experiments) have been widely
        applied in different industries to optimize business processes and user
        experience. ExpAn (**Exp**\ eriment **An**\ alysis) is a Python library
        developed for the statistical analysis of such experiments and to standardise
        the data structures used.
        
        The data structures and functionality of ExpAn are generic such that they can be
        used by both data scientists optimizing a user interface and biologists
        running wet-lab experiments. The library is also standalone and can be
        imported and used from within other projects and from the command line.
        
        Major statistical functionalities include:
        
        - **feature check**
        - **delta**
        - **subgroup analysis**
        - **trend**
        
        
        Installation
        ============
        
        To install ExpAn, run this command in your terminal:
        
        .. code-block:: console
        
            $ pip install expan
        
        
        Usage
        =====
        
        To use ExpAn in a project::
        
            import expan
        
        Some mock-up data:
        
        ::
        
            from expan.core.experiment import Experiment
            from tests.tests_core.test_data import generate_random_data
        
            exp = Experiment('B', *generate_random_data())
            exp.delta()
        
        
        
        Documentation
        =============
        
        The latest stable version is 0.5.0.
        
        `ExpAn main documentation <http://expan.readthedocs.io/>`__
        
        `ExpAn Description <https://github.com/zalando/expan/blob/master/ExpAn-Description.mediawiki>`__ - details about the concept of the library and data structures.
        
        `ExpAn Introduction <https://github.com/zalando/expan/blob/dev/ExpAn-Intro.ipynb>`__ - a full jupyter (iPython) notebook. You can view it as slides with `jupyter <http://jupyter.org>`__:
        
        ::
        
            sh serve_intro_slides
        
        
        License
        =======
        
        The MIT License (MIT)
        
        Copyright © [2016] Zalando SE, https://tech.zalando.com
        
        Permission is hereby granted, free of charge, to any person obtaining a
        copy of this software and associated documentation files (the
        “Software”), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be included
        in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS
        OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
        CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
        TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
        SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
        
        Change Log
        ==========
        
        `v0.4.5 <https://github.com/zalando/expan/tree/v0.4.5>`__ (2017-02-10)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.4.4...v0.4.5>`__
        
        **Fixed bugs:**
        
        -  Numbers cannot appear in variable names for derived metrics
           `#58 <https://github.com/zalando/expan/issues/58>`__
        
        **Merged pull requests:**
        
        -  Feature/results and to json refactor
           `#74 <https://github.com/zalando/expan/pull/74>`__
           (`mkolarek <https://github.com/mkolarek>`__)
        -  Merge to\_json() and prob\_uplift\_over\_zero changes
           `#72 <https://github.com/zalando/expan/pull/72>`__
           (`mkolarek <https://github.com/mkolarek>`__)
        -  regex fix, see https://github.com/zalando/expan/issues/58
           `#70 <https://github.com/zalando/expan/pull/70>`__
           (`gbordyugov <https://github.com/gbordyugov>`__)
        
        `v0.4.4 <https://github.com/zalando/expan/tree/v0.4.4>`__ (2017-02-09)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.4.3...v0.4.4>`__
        
        **Implemented enhancements:**
        
        -  Add argument assume\_normal and treatment\_cost to
           calculate\_prob\_uplift\_over\_zero() and
           prob\_uplift\_over\_zero\_single\_metric()
           `#26 <https://github.com/zalando/expan/issues/26>`__
        -  host intro slides (from the ipython notebook) somewhere for public
           viewing `#10 <https://github.com/zalando/expan/issues/10>`__
        
        **Closed issues:**
        
        -  migrate issues from github enterprise
           `#20 <https://github.com/zalando/expan/issues/20>`__
        
        **Merged pull requests:**
        
        -  Feature/results and to json refactor
           `#71 <https://github.com/zalando/expan/pull/71>`__
           (`mkolarek <https://github.com/mkolarek>`__)
        -  new to\_json() functionality and improved vim support
           `#67 <https://github.com/zalando/expan/pull/67>`__
           (`mkolarek <https://github.com/mkolarek>`__)
        
        `v0.4.3 <https://github.com/zalando/expan/tree/v0.4.3>`__ (2017-02-07)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.4.2...v0.4.3>`__
        
        **Closed issues:**
        
        -  coverage % is misleading
           `#23 <https://github.com/zalando/expan/issues/23>`__
        
        **Merged pull requests:**
        
        -  Vim modelines `#63 <https://github.com/zalando/expan/pull/63>`__
           (`gbordyugov <https://github.com/gbordyugov>`__)
        -  Feature/octo 1253 expan results in json
           `#62 <https://github.com/zalando/expan/pull/62>`__
           (`mkolarek <https://github.com/mkolarek>`__)
        -  0.4.2 release `#60 <https://github.com/zalando/expan/pull/60>`__
           (`mkolarek <https://github.com/mkolarek>`__)
        
        `v0.4.2 <https://github.com/zalando/expan/tree/v0.4.2>`__ (2016-12-08)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.4.1...v0.4.2>`__
        
        **Fixed bugs:**
        
        -  frequency table in the chi square test doesn't respect the order of
           categories `#56 <https://github.com/zalando/expan/issues/56>`__
        
        **Merged pull requests:**
        
        -  OCTO-1143 Review outlier filtering
           `#59 <https://github.com/zalando/expan/pull/59>`__
           (`domheger <https://github.com/domheger>`__)
        -  Workaround to fix #56
           `#57 <https://github.com/zalando/expan/pull/57>`__
           (`jbao <https://github.com/jbao>`__)
        
        `v0.4.1 <https://github.com/zalando/expan/tree/v0.4.1>`__ (2016-10-18)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.4.0...v0.4.1>`__
        
        **Merged pull requests:**
        
        -  small doc cleanup `#55 <https://github.com/zalando/expan/pull/55>`__
           (`jbao <https://github.com/jbao>`__)
        -  Add comments to cli.py
           `#54 <https://github.com/zalando/expan/pull/54>`__
           (`igusher <https://github.com/igusher>`__)
        
        `v0.4.0 <https://github.com/zalando/expan/tree/v0.4.0>`__ (2016-08-19)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.3.4...v0.4.0>`__
        
        **Closed issues:**
        
        -  Support 'overall ratio' metrics (e.g. conversion rate/return rate) as
           opposed to per-entity ratios
           `#44 <https://github.com/zalando/expan/issues/44>`__
        
        `v0.3.4 <https://github.com/zalando/expan/tree/v0.3.4>`__ (2016-08-08)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.3.3...v0.3.4>`__
        
        **Closed issues:**
        
        -  perform trend analysis cumulatively
           `#31 <https://github.com/zalando/expan/issues/31>`__
        -  Python3 `#21 <https://github.com/zalando/expan/issues/21>`__
        
        `v0.3.3 <https://github.com/zalando/expan/tree/v0.3.3>`__ (2016-08-02)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.3.2...v0.3.3>`__
        
        `v0.3.2 <https://github.com/zalando/expan/tree/v0.3.2>`__ (2016-08-02)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.3.1...v0.3.2>`__
        
        `v0.3.1 <https://github.com/zalando/expan/tree/v0.3.1>`__ (2016-07-15)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.3.0...v0.3.1>`__
        
        `v0.3.0 <https://github.com/zalando/expan/tree/v0.3.0>`__ (2016-06-23)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.2.5...v0.3.0>`__
        
        **Implemented enhancements:**
        
        -  Add P(uplift>0) as a statistic
           `#2 <https://github.com/zalando/expan/issues/2>`__
        
        `v0.2.5 <https://github.com/zalando/expan/tree/v0.2.5>`__ (2016-05-30)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.2.4...v0.2.5>`__
        
        **Implemented enhancements:**
        
        -  Implement \_\_version\_\_
           `#14 <https://github.com/zalando/expan/issues/14>`__
        
        **Closed issues:**
        
        -  upload full documentation!
           `#1 <https://github.com/zalando/expan/issues/1>`__
        
        `v0.2.4 <https://github.com/zalando/expan/tree/v0.2.4>`__ (2016-05-16)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.2.3...v0.2.4>`__
        
        **Closed issues:**
        
        -  No module named experiment and test\_data
           `#13 <https://github.com/zalando/expan/issues/13>`__
        
        `v0.2.3 <https://github.com/zalando/expan/tree/v0.2.3>`__ (2016-05-06)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.2.2...v0.2.3>`__
        
        `v0.2.2 <https://github.com/zalando/expan/tree/v0.2.2>`__ (2016-05-06)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.2.1...v0.2.2>`__
        
        `v0.2.1 <https://github.com/zalando/expan/tree/v0.2.1>`__ (2016-05-06)
        ----------------------------------------------------------------------
        
        `Full
        Changelog <https://github.com/zalando/expan/compare/v0.2.0...v0.2.1>`__
        
        `v0.2.0 <https://github.com/zalando/expan/tree/v0.2.0>`__ (2016-05-06)
        ----------------------------------------------------------------------
        
        \* *This Change Log was automatically generated by
        `github\_changelog\_generator <https://github.com/skywinder/Github-Changelog-Generator>`__*
        
Keywords: expan
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
