Metadata-Version: 2.1
Name: phik
Version: 0.11.2
Summary: Phi_K correlation analyzer library
Home-page: http://phik.rtfd.io
Author: KPMG N.V. The Netherlands
Author-email: kave@kpmg.com
License: Apache-2
Description: ==================================
        Phi_K Correlation Analyzer Library
        ==================================
        
        * Version: 0.11.2. Released: Mar 2021
        * Documentation: https://phik.readthedocs.io
        * Repository: https://github.com/kaveio/phik
        * Publication: `[offical] <https://www.sciencedirect.com/science/article/abs/pii/S0167947320301341>`_ `[arxiv pre-print] <https://arxiv.org/abs/1811.11440>`_
        
        Phi_K is a practical correlation constant that works consistently between categorical, ordinal and interval variables.
        It is based on several refinements to Pearson's hypothesis test of independence of two variables.
        
        The combined features of Phi_K form an advantage over existing coefficients. First, it works consistently between categorical, ordinal and interval variables.
        Second, it captures non-linear dependency. Third, it reverts to the Pearson correlation coefficient in case of a bi-variate normal input distribution.
        These are useful features when studying the correlation matrix of variables with mixed types.
        
        The presented algorithms are easy to use and available through this public Python library: the correlation analyzer package.
        Emphasis is paid to the proper evaluation of statistical significance of correlations and to the interpretation of variable relationships
        in a contingency table, in particular in case of low statistics samples.
        
        For example, the Phi_K correlation analyzer package has been used to study surveys, insurance claims, correlograms, etc.
        For details on the methodology behind the calculations, please see our publication.
        
        
        Documentation
        =============
        
        The entire Phi_K documentation including tutorials can be found at `read-the-docs <https://phik.readthedocs.io>`_.
        See the tutorials for detailed examples on how to run the code with pandas. We also have one example on how
        calculate the Phi_K correlation matrix for a spark dataframe.
        
        
        Check it out
        ============
        
        The Phi_K library requires Python 3 and is pip friendly. To get started, simply do:
        
        .. code-block:: bash
        
          $ pip install phik
        
        or check out the code from out GitHub repository:
        
        .. code-block:: bash
        
          $ git clone https://github.com/KaveIO/PhiK.git
          $ pip install -e PhiK/
        
        where in this example the code is installed in edit mode (option -e).
        
        You can now use the package in Python with:
        
        .. code-block:: python
        
          import phik
        
        **Congratulations, you are now ready to use the PhiK correlation analyzer library!**
        
        Speedups
        --------
        
        Phi_K can use the Numba JIT library for faster computation of certain operations.
        You can either install Numba separately or use the `numba` extra specifier while installing:
        
        .. code-block:: bash
        
          $ pip install phik[numba]
        
        Quick run
        =========
        
        As a quick example, you can do:
        
        .. code-block:: python
        
          import pandas as pd
          import phik
          from phik import resources, report
        
          # open fake car insurance data
          df = pd.read_csv( resources.fixture('fake_insurance_data.csv.gz') )
          df.head()
        
          # Pearson's correlation matrix between numeric variables (pandas functionality)
          df.corr()
        
          # get the phi_k correlation matrix between all variables
          df.phik_matrix()
        
          # get global correlations based on phi_k correlation matrix
          df.global_phik()
        
          # get the significance matrix (expressed as one-sided Z)
          # of the hypothesis test of each variable-pair dependency
          df.significance_matrix()
        
          # contingency table of two columns
          cols = ['mileage','car_size']
          df[cols].hist2d()
        
          # normalized residuals of contingency test applied to cols
          df[cols].outlier_significance_matrix()
        
          # show the normalized residuals of each variable-pair
          df.outlier_significance_matrices()
        
          # generate a phik correlation report and save as test.pdf
          report.correlation_report(df, pdf_file_name='test.pdf')
        
        
        For all available examples, please see the `tutorials <https://phik.readthedocs.io/en/latest/tutorials.html>`_ at read-the-docs.
        
        
        Contact and support
        ===================
        
        * Issues and Ideas: https://github.com/kaveio/phik/issues
        
        Please note that KPMG provides support only on a best-effort basis.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
Provides-Extra: numba
