formulaic-contrasts

Name	formulaic-contrasts JSON
Version	1.0.0 JSON
	download
home_page	None
Summary	Build contrasts for models defined with formulaic
upload_time	2024-12-15 13:44:06
maintainer	None
docs_url	None
author	Gregor Sturm
requires_python	>=3.10
license	BSD 3-Clause License Copyright (c) 2024, Gregor Sturm All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # formulaic-contrasts

[![Tests][badge-tests]][tests]
[![Documentation][badge-docs]][documentation]
[![codecov.io][badge-codecov]][link-codecov]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/scverse/formulaic-contrasts/test.yaml?branch=main
[badge-docs]: https://img.shields.io/readthedocs/formulaic-contrasts
[badge-codecov]: https://codecov.io/github/scverse/formulaic-contrasts/coverage.svg?branch=main
[link-codecov]: https://codecov.io/gh/scverse/formulaic-contrasts/branch/main

Build arbitrary contrasts for models defined with formulaic.

## Getting started

Please refer to the [documentation][]. As a developer seeking to use `formulaic-contrasts` with your model, you'll find
the [API documentation][] and the tutorial [Usage in custom model][] useful. If you are a user who wants to understand
how to build contrasts for a model, the [building contrasts][] tutorial is for you!

## Installation

Typically, you don't install `formulaic-contrasts` directly, but obtain it as a dependency of
another model. As a developer, you can obtain it from PyPI or GitHub:

There are several alternative options to install formulaic-contrasts:

1. Install the latest release of `formulaic-contrasts` from [PyPI][]:

```bash
pip install formulaic-contrasts
```

2. Install the latest development version:

```bash
pip install git+https://github.com/scverse/formulaic-contrasts.git@main
```

`Formulaic-contrasts` depends on Python 3.10 or later.

## Release notes

See the [changelog][].

## Contact

For questions and help requests, you can reach out in the [scverse discourse][].
If you found a bug, please use the [issue tracker][].

## Credits

The `cond()` function for building contrasts has been devised by [@const-ae](https://github.com/const-ae) for his R package [glmGamPoi](https://bioconductor.org/packages/release/bioc/html/glmGamPoi.html). A [prototype](https://github.com/scverse/multi-condition-comparisions) of the Python implementation has been built at the [scverse hackathon in Cambridge, UK in Nov 2023](https://scverse.org/events/2023_11_hackathon/) by [@grst](https://github.com/grst), [@const-ae](https://github.com/const-ae) and [@BorisMuzellec](https://github.com/BorisMuzellec). The production version in this package has been implemented by [@grst](https://github.com/grst).

[mambaforge]: https://github.com/conda-forge/miniforge#mambaforge
[scverse discourse]: https://discourse.scverse.org/
[issue tracker]: https://github.com/scverse/formulaic-contrasts/issues
[tests]: https://github.com/scverse/formulaic-contrasts/actions/workflows/test.yml
[documentation]: https://formulaic-contrasts.readthedocs.io
[changelog]: https://formulaic-contrasts.readthedocs.io/en/latest/changelog.html
[api documentation]: https://formulaic-contrasts.readthedocs.io/en/latest/api.html
[usage in custom model]: https://formulaic-contrasts.readthedocs.io/en/latest/model_usage.html
[building contrasts]: https://formulaic-contrasts.readthedocs.io/en/latest/contrasts.html
[pypi]: https://pypi.org/project/formulaic-contrasts

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "formulaic-contrasts",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Gregor Sturm <gregor.sturm@scverse.org>",
    "keywords": null,
    "author": "Gregor Sturm",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/28/e6/4850976c248746062cfaa08628b3ec5ba3dfcab3d6ecd0d3886c36c04681/formulaic_contrasts-1.0.0.tar.gz",
    "platform": null,
    "description": "# formulaic-contrasts\n\n[![Tests][badge-tests]][tests]\n[![Documentation][badge-docs]][documentation]\n[![codecov.io][badge-codecov]][link-codecov]\n\n[badge-tests]: https://img.shields.io/github/actions/workflow/status/scverse/formulaic-contrasts/test.yaml?branch=main\n[badge-docs]: https://img.shields.io/readthedocs/formulaic-contrasts\n[badge-codecov]: https://codecov.io/github/scverse/formulaic-contrasts/coverage.svg?branch=main\n[link-codecov]: https://codecov.io/gh/scverse/formulaic-contrasts/branch/main\n\nBuild arbitrary contrasts for models defined with formulaic.\n\n## Getting started\n\nPlease refer to the [documentation][]. As a developer seeking to use `formulaic-contrasts` with your model, you'll find\nthe [API documentation][] and the tutorial [Usage in custom model][] useful. If you are a user who wants to understand\nhow to build contrasts for a model, the [building contrasts][] tutorial is for you!\n\n## Installation\n\nTypically, you don't install `formulaic-contrasts` directly, but obtain it as a dependency of\nanother model. As a developer, you can obtain it from PyPI or GitHub:\n\nThere are several alternative options to install formulaic-contrasts:\n\n1. Install the latest release of `formulaic-contrasts` from [PyPI][]:\n\n```bash\npip install formulaic-contrasts\n```\n\n2. Install the latest development version:\n\n```bash\npip install git+https://github.com/scverse/formulaic-contrasts.git@main\n```\n\n`Formulaic-contrasts` depends on Python 3.10 or later.\n\n## Release notes\n\nSee the [changelog][].\n\n## Contact\n\nFor questions and help requests, you can reach out in the [scverse discourse][].\nIf you found a bug, please use the [issue tracker][].\n\n## Credits\n\nThe `cond()` function for building contrasts has been devised by [@const-ae](https://github.com/const-ae) for his R package [glmGamPoi](https://bioconductor.org/packages/release/bioc/html/glmGamPoi.html). A [prototype](https://github.com/scverse/multi-condition-comparisions) of the Python implementation has been built at the [scverse hackathon in Cambridge, UK in Nov 2023](https://scverse.org/events/2023_11_hackathon/) by [@grst](https://github.com/grst), [@const-ae](https://github.com/const-ae) and [@BorisMuzellec](https://github.com/BorisMuzellec). The production version in this package has been implemented by [@grst](https://github.com/grst).\n\n[mambaforge]: https://github.com/conda-forge/miniforge#mambaforge\n[scverse discourse]: https://discourse.scverse.org/\n[issue tracker]: https://github.com/scverse/formulaic-contrasts/issues\n[tests]: https://github.com/scverse/formulaic-contrasts/actions/workflows/test.yml\n[documentation]: https://formulaic-contrasts.readthedocs.io\n[changelog]: https://formulaic-contrasts.readthedocs.io/en/latest/changelog.html\n[api documentation]: https://formulaic-contrasts.readthedocs.io/en/latest/api.html\n[usage in custom model]: https://formulaic-contrasts.readthedocs.io/en/latest/model_usage.html\n[building contrasts]: https://formulaic-contrasts.readthedocs.io/en/latest/contrasts.html\n[pypi]: https://pypi.org/project/formulaic-contrasts\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2024, Gregor Sturm All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
    "summary": "Build contrasts for models defined with formulaic",
    "version": "1.0.0",
    "project_urls": {
        "Documentation": "https://formulaic-contrasts.readthedocs.io/",
        "Homepage": "https://github.com/scverse/formulaic-contrasts",
        "Source": "https://github.com/scverse/formulaic-contrasts"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "407b639411281256c84e8111bf6cb9676c44dbf5d8ad4cb042f4359b7e7b9e74",
                "md5": "14ee6a2aa88a70fd3b355ff862cfd333",
                "sha256": "e1220d315cf446bdec9385375ca4da43896e4ba68114ebea1b2a37efa5d097f5"
            },
            "downloads": -1,
            "filename": "formulaic_contrasts-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "14ee6a2aa88a70fd3b355ff862cfd333",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10054,
            "upload_time": "2024-12-15T13:44:05",
            "upload_time_iso_8601": "2024-12-15T13:44:05.454727Z",
            "url": "https://files.pythonhosted.org/packages/40/7b/639411281256c84e8111bf6cb9676c44dbf5d8ad4cb042f4359b7e7b9e74/formulaic_contrasts-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "28e64850976c248746062cfaa08628b3ec5ba3dfcab3d6ecd0d3886c36c04681",
                "md5": "1a1c1bf1bcfb8d6dcf4d7018de269844",
                "sha256": "0a575a810bf1fba28938259d86a3ae2ae90cb9826fca84b9409085170862f701"
            },
            "downloads": -1,
            "filename": "formulaic_contrasts-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1a1c1bf1bcfb8d6dcf4d7018de269844",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 123794,
            "upload_time": "2024-12-15T13:44:06",
            "upload_time_iso_8601": "2024-12-15T13:44:06.844098Z",
            "url": "https://files.pythonhosted.org/packages/28/e6/4850976c248746062cfaa08628b3ec5ba3dfcab3d6ecd0d3886c36c04681/formulaic_contrasts-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-15 13:44:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "scverse",
    "github_project": "formulaic-contrasts",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "formulaic-contrasts"
}