formulaic-contrasts
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:
- Install the latest release of
formulaic-contrastsfrom PyPI:
pip install formulaic-contrasts
- Install the latest development version:
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 for his R package glmGamPoi. A prototype of the Python implementation has been built at the scverse hackathon in Cambridge, UK in Nov 2023 by @grst, @const-ae and @BorisMuzellec. The production version in this package has been implemented by @grst.
1 maintainer
Metadata
1 maintainer
Release files for formulaic-contrasts 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| formulaic_contrasts-1.0.0.tar.gz | 123.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| formulaic_contrasts-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 133.8 kB
Release files / formulaic_contrasts-1.0.0.tar.gz
| Download URL | formulaic_contrasts-1.0.0.tar.gz |
|---|---|
| Size | 123.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0a575a810bf1fba28938259d86a3ae2ae90cb9826fca84b9409085170862f701
|
|
BLAKE2b-256 checksum How to use checksums |
28e64850976c248746062cfaa08628b3ec5ba3dfcab3d6ecd0d3886c36c04681
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 15, 2024.
Transparency logRelease files / formulaic_contrasts-1.0.0-py3-none-any.whl
| Download URL | formulaic_contrasts-1.0.0-py3-none-any.whl |
|---|---|
| Size | 10.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e1220d315cf446bdec9385375ca4da43896e4ba68114ebea1b2a37efa5d097f5
|
|
BLAKE2b-256 checksum How to use checksums |
407b639411281256c84e8111bf6cb9676c44dbf5d8ad4cb042f4359b7e7b9e74
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 15, 2024.
Transparency log
