Metadata-Version: 2.1
Name: regmod
Version: 0.0.5
Summary: regmod: General regression models.
Home-page: https://github.com/zhengp0/regmod
Author: Peng Zheng
Author-email: zhengp@uw.edu
License: BSD 2-Clause License
Platform: UNKNOWN
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: xspline
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Provides-Extra: docs
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'

.. image:: https://github.com/zhengp0/regmod/workflows/python-build/badge.svg
    :target: https://github.com/zhengp0/regmod/actions

.. image:: https://badge.fury.io/py/regmod.svg
    :target: https://badge.fury.io/py/regmod

Regression Models
=================

This package is design for general regression models including
generalized linear models and others.

It features

* Bayesian framework, allows user to include priors into the mdoel.
* Easy spline interface and spline shape priors and constraint.

Current model pool contains:

* Linear model
* Poisson model
* Binomial model

Install
-------
Package requires Python version above ``3.7``, recommend using version ``3.8``.

To install the package, the simplest way is through ``pip``,

.. code-block:: bash

    pip install regmod

Or you could clone this repository and do,

.. code-block:: bash

    python setup.py install

Acknowledgement
---------------
Design idea of this package comes from
`"Animal" package <https://github.com/ihmeuw-msca/anml>`_.
It is a general tool building template, for more detail please check the link above.


