Skip to main content

Package implementing PLN models

Project description

PLNmodels: Poisson lognormal models

The Poisson lognormal model and variants can be used for analysis of mutivariate count data. This package implements efficient algorithms extracting meaningful data from difficult to interpret and complex multivariate count data. It has been built to scale on large datasets even though it has memory limitations. Possible fields of applications include

  • Genomics (number of times a gene is expressed in a cell)
  • Ecology (species abundances)

One main functionality is to normalize the count data to obtain more valuable data. It also analyse the significance of each variable and their correlation as well as the weight of covariates (if available).

Getting started

The getting started can be found here. If you need just a quick view of the package, see the quickstart next.

🛠 Installation

pyPLNmodels is available on pypi. The development version is available on GitHub.

Package installation

pip install pyPLNmodels

⚡️ Quickstart

The package comes with an ecological data set to present the functionality

import pyPLNmodels
from pyPLNmodels.models import PlnPCAcollection, Pln, ZIPln
from pyPLNmodels.oaks import load_oaks
oaks = load_oaks()

Unpenalized Poisson lognormal model (aka PLN)

pln = Pln.from_formula("endog ~ 1  + tree + dist2ground + orientation ", data = oaks, take_log_offsets = True)
pln.fit()
print(pln)
transformed_data = pln.transform()

Rank Constrained Poisson lognormal for Poisson Principal Component Analysis (aka PLNPCA)

pca =  PlnPCAcollection.from_formula("endog ~ 1  + tree + dist2ground + orientation ", data = oaks, take_log_offsets = True, ranks = [3,4,5])
pca.fit()
print(pca)
transformed_data = pca.best_model().transform()

Zero inflated Poisson Log normal Model (aka ZIPln)

zi =  ZIPln.from_formula("endog ~ 1  + tree + dist2ground + orientation ", data = oaks, take_log_offsets = True)
zi.fit()
print(zi)
transformed_data = zi.transform()

👐 Contributing

Feel free to contribute, but read the CONTRIBUTING.md first. A public roadmap will be available soon.

⚡️ Citations

Please cite our work using the following references:

  • J. Chiquet, M. Mariadassou and S. Robin: Variational inference for probabilistic Poisson PCA, the Annals of Applied Statistics, 12: 2674–2698, 2018. link

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyplnmodels-0.0.76.tar.gz (3.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyPLNmodels-0.0.76-py3-none-any.whl (320.1 kB view details)

Uploaded Python 3

File details

Details for the file pyplnmodels-0.0.76.tar.gz.

File metadata

  • Download URL: pyplnmodels-0.0.76.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for pyplnmodels-0.0.76.tar.gz
Algorithm Hash digest
SHA256 5942018e7512f207deae32d752c6c965098b0edd2ca72f6a6b1ddc70de4c52d0
MD5 9a1c7f9775a00478d1c551976a2ed6ca
BLAKE2b-256 d46ed24bd91b15344494a9d61e77c9be9cebe4a069e885fee5865522975b07d3

See more details on using hashes here.

File details

Details for the file pyPLNmodels-0.0.76-py3-none-any.whl.

File metadata

  • Download URL: pyPLNmodels-0.0.76-py3-none-any.whl
  • Upload date:
  • Size: 320.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for pyPLNmodels-0.0.76-py3-none-any.whl
Algorithm Hash digest
SHA256 b95d85fbd2e4d31e14434116c971253a097c28da98cbadf6cdc17aeb3dc0808c
MD5 cbec81e09dc58775887b40886c1176d9
BLAKE2b-256 4e866471b8208114954a5c57d1440b177a24177f12e54064ba511e91f9061ede

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page