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.

⚡️ Quickstart

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

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

Unpenalized Poisson lognormal model (aka PLN)

pln = Pln.from_formula("counts ~ 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("counts ~ 1  + tree + dist2ground + orientation ", data = oaks, take_log_offsets = True, ranks = [3,4,5])
pca.fit()
print(pca)
transformed_data = pln.transform()

🛠 Installation

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

Package installation

pip install pyPLNmodels

👐 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.68.tar.gz (3.4 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.68-py3-none-any.whl (147.2 kB view details)

Uploaded Python 3

File details

Details for the file pyPLNmodels-0.0.68.tar.gz.

File metadata

  • Download URL: pyPLNmodels-0.0.68.tar.gz
  • Upload date:
  • Size: 3.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for pyPLNmodels-0.0.68.tar.gz
Algorithm Hash digest
SHA256 b8be3afebd913abe3a1c23976c22e8fe218eac3938f08b9008a20c3502d4cba8
MD5 821ff2750946d4c15b250e70a2f0291a
BLAKE2b-256 59123e199f27a81c10c1194224d6aa198ad88954025886dc8061c94dc5265bf2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyPLNmodels-0.0.68-py3-none-any.whl
  • Upload date:
  • Size: 147.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for pyPLNmodels-0.0.68-py3-none-any.whl
Algorithm Hash digest
SHA256 417085a7f9ec1291e7ed02046669b00762e08b8c3355a2a318155b3aff271ed7
MD5 4a6f83b399bae56dfb004eff70dfdac6
BLAKE2b-256 5d85eacb133b2a7642d119e76e20045d15b6d1baf4208d26a4eb062ab92bec6e

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