Metadata-Version: 2.1
Name: smallerize
Version: 0.4.0
Summary: A Python implementation of minimisation for clinical trials
Home-page: https://gitlab.com/warsquid/smallerize
Author: Marius Mather
Author-email: marius.mather@gmail.com
License: Mozilla Public License 2.0 (MPL 2.0)
Keywords: smallerize
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7

==========
smallerize
==========


.. image:: https://img.shields.io/pypi/v/smallerize.svg
        :target: https://pypi.python.org/pypi/smallerize
        :alt: pip version

.. image:: https://gitlab.com/warsquid/smallerize/badges/master/coverage.svg
        :alt: Coverage

.. image:: https://readthedocs.org/projects/smallerize/badge/?version=latest
        :target: https://smallerize.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status




A Python implementation of minimisation for clinical trials


* Open source: Mozilla Public License 2.0
* Documentation: https://smallerize.readthedocs.io.
* Source: https://gitlab.com/warsquid/smallerize.


Features
--------

* Implements minimization as described in Pocock + Simon (1975): *Sequential
  treatment assignment with balancing for prognostic factors in the
  controlled clinical trial*
* Tested using ``pytest`` to ensure the results match the original
  implementation.
* Pure Python module with no dependencies (``pandas`` is useful when conducting
  simulations but is optional)
* Includes all functions described in the article: range, standard deviation,
  variance, etc.
* Also implements the biased-coin minimization method described in Han et al. (2009):
  *Randomization by minimization for unbalanced treatment allocation*, to
  allow for unequal allocation ratios.
* Allows pure random assignment for comparison
* Simulation module to allow simulating the effects of different assignment
  schemes.

Example
-------

Comparing minimization to purely random assignment by simulation:

.. image:: https://gitlab.com/warsquid/smallerize/raw/master/examples/ps1975_factor_imbalance.png
        :width: 1350
        :height: 600
        :scale: 50%
        :alt: Simulation results

See the example notebook at
https://gitlab.com/warsquid/smallerize/blob/master/examples/ps1975_simulations.ipynb
for details of the simulation.

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.4.0 (2019-02-02)
------------------

* Switched to Mozilla Public License.

0.3.0 (2019-01-02)
------------------

* Make it easier to check the valid total imbalance and
  probability methods.

0.2.0 (2018-10-22)
------------------

* Add the biased coin minimization method to allow
  for unequal treatment allocations.

0.1.0 (2018-10-07)
------------------

* First release on PyPI.


