Skip to content

Commit 0ab1c4e

Browse files
[vignette] Remove footnote from README and use proper citation style for consistency with vignette
1 parent 5321a64 commit 0ab1c4e

3 files changed

Lines changed: 207 additions & 98 deletions

File tree

README.md

Lines changed: 125 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,44 @@ status](https://codecov.io/gh/pln-team/PLNmodels/branch/master/graph/badge.svg)]
1010
[![Lifecycle:
1111
stable](https://img.shields.io/badge/lifecycle-stable-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html)
1212
[![](https://img.shields.io/github/last-commit/pln-team/PLNmodels.svg)](https://github.com/pln-team/PLNmodels/commits/master)
13+
1314
<!-- badges: end -->
1415

1516
## Description
1617

17-
> The Poisson lognormal model and variants[^1] can be used for a variety
18-
> of multivariate problems when count data are at play. This package
19-
> implements efficient variational algorithms to fit such models,
20-
> accompanied with a set of functions for visualization and diagnostic.
21-
> See [all the dedicated
22-
> vignettes](https://pln-team.github.io/PLNmodels/articles/) for a
23-
> comprehensive introduction.
18+
> The Poisson lognormal model and variants ([Chiquet et al.
19+
> 2021](#ref-chiquet2021)) can be used for a variety of multivariate
20+
> problems when count data are at play. This package implements
21+
> efficient variational algorithms to fit such models, accompanied with
22+
> a set of functions for visualization and diagnostic. See [all the
23+
> dedicated vignettes](https://pln-team.github.io/PLNmodels/articles/)
24+
> for a comprehensive introduction.
2425
2526
**PLNmodels** covers the following models, all built around the
2627
multivariate Poisson-lognormal distribution and sharing a common
2728
formula-based interface (covariates, offsets, weights) and a choice of
2829
optimization backends (a fast built-in Newton solver, NLOPT, and an
2930
experimental torch backend):
3031

31-
- **PLN**[^2]: unpenalized multivariate Poisson regression, with several
32-
covariance structures (full, diagonal, spherical, fixed, or a
33-
genetic/heritability structure).
34-
- **PLNPCA**[^3]: probabilistic Poisson PCA — a rank-constrained
35-
covariance for dimension reduction and visualization.
36-
- **PLNLDA**: Poisson lognormal discriminant analysis[^4] for the
37-
supervised classification of count data.
38-
- **PLNnetwork**[^5]: sparse inverse-covariance (network) inference via
39-
a graphical-lasso-like penalty[^6].
40-
- **PLNmixture**: model-based clustering[^7] of count data via a mixture
41-
of PLN models.
42-
- **ZIPLN**[^8]: a zero-inflated extension of PLN for data with excess
43-
zeros, with the same family of covariance structures and an optional
44-
sparse (`ZIPLNnetwork`[^9]) variant.
32+
- **PLN** ([Aitchison and Ho 1989](#ref-AiH89)): unpenalized
33+
multivariate Poisson regression, with several covariance structures
34+
(full, diagonal, spherical, fixed, or a genetic/heritability
35+
structure).
36+
- **PLNPCA** ([Chiquet et al. 2018](#ref-PLNPCA)): probabilistic Poisson
37+
PCA — a rank-constrained covariance for dimension reduction and
38+
visualization.
39+
- **PLNLDA**: Poisson lognormal discriminant analysis ([Fisher
40+
1936](#ref-fisher1936)) for the supervised classification of count
41+
data.
42+
- **PLNnetwork** ([Chiquet et al. 2019](#ref-PLNnetwork)): sparse
43+
inverse-covariance (network) inference via a graphical-lasso-like
44+
penalty ([Friedman et al. 2008](#ref-FHT08)).
45+
- **PLNmixture**: model-based clustering ([Fraley and Raftery
46+
1999](#ref-fraley1999)) of count data via a mixture of PLN models.
47+
- **ZIPLN** ([Batardière et al. 2025](#ref-ZIPLN)): a zero-inflated
48+
extension of PLN for data with excess zeros, with the same family of
49+
covariance structures and an optional sparse (`ZIPLNnetwork`) variant
50+
([Tous et al. 2025](#ref-ZIPLNnetwork)).
4551

4652
## Installation
4753

@@ -57,9 +63,10 @@ remotes::install_github("pln-team/PLNmodels@tag_number") # a specific tagged re
5763

5864
## Illustration
5965

60-
We illustrate the main models on the `barents` data set[^10]: the
61-
abundance of 30 fish species observed in 89 sites in the Barents sea,
62-
along with depth, temperature and geographic coordinates for each site.
66+
We illustrate the main models on the `barents` data set ([Fossheim et
67+
al. 2006](#ref-fossheim2006)): the abundance of 30 fish species observed
68+
in 89 sites in the Barents sea, along with depth, temperature and
69+
geographic coordinates for each site.
6370

6471
``` r
6572
library(PLNmodels)
@@ -91,8 +98,8 @@ myPLN
9198

9299
A multivariate Poisson Lognormal fit with full covariance model.
93100
==================================================================
94-
nb_param loglik BIC AIC ICL
95-
555 -4412.201 -5657.797 -4967.201 -8203.81
101+
nb_param loglik BIC AIC ICL
102+
555 -4412.385 -5657.981 -4967.385 -8194.015
96103
==================================================================
97104
* Useful fields
98105
$model_par, $latent, $latent_pos, $var_par, $optim_par
@@ -231,54 +238,99 @@ table(cluster = myMixture$memberships, zone = barents$zone)
231238

232239
zone
233240
cluster North South
234-
1 1 17
235-
2 11 0
236-
3 11 22
241+
1 11 0
242+
2 11 22
243+
3 1 17
237244
4 21 6
238245

239246
## References
240247

241-
[^1]: J. Chiquet, M. Mariadassou and S. Robin: The Poisson-lognormal
242-
model as a versatile framework for the joint analysis of species
243-
abundances, Frontiers in Ecology and Evolution, 2021.
244-
[doi:10.3389/fevo.2021.588292](https://www.frontiersin.org/articles/10.3389/fevo.2021.588292/full)
245-
246-
[^2]: Aitchison, J. and Ho, C. H. The multivariate Poisson-log normal
247-
distribution. Biometrika, 76(4), 1989, 643–653.
248-
249-
[^3]: J. Chiquet, M. Mariadassou and S. Robin: Variational inference for
250-
probabilistic Poisson PCA, the Annals of Applied Statistics, 12:
251-
2674–2698, 2018.
252-
[doi:10.1214/18-AOAS1177](http://dx.doi.org/10.1214/18%2DAOAS1177)
253-
254-
[^4]: Fisher, R. A. The use of multiple measurements in taxonomic
255-
problems. Annals of Eugenics, 7(2), 1936; Rao, C. R. The utilization
256-
of multiple measurements in problems of biological classification.
257-
JRSS B, 10(2), 1948.
258-
259-
[^5]: J. Chiquet, M. Mariadassou and S. Robin: Variational inference for
260-
sparse network reconstruction from count data, Proceedings of the
261-
36th International Conference on Machine Learning (ICML), 2019.
262-
[link](http://proceedings.mlr.press/v97/chiquet19a.html)
263-
264-
[^6]: Friedman, J., Hastie, T. and Tibshirani, R. Sparse inverse
265-
covariance estimation with the graphical lasso. Biostatistics, 9(3),
266-
2008.
267-
268-
[^7]: Fraley, C. and Raftery, A. E. MCLUST: Software for model-based
269-
cluster analysis. Journal of Classification, 16(2), 1999.
270-
271-
[^8]: Batardière, B., Chiquet, J., Gindraud, F. and Mariadassou, M.
272-
Zero-inflation in the multivariate Poisson lognormal family.
273-
Statistics and Computing, 35, 2025.
274-
[doi:10.1007/s11222-025-10729-0](https://doi.org/10.1007/s11222-025-10729-0)
275-
276-
[^9]: Tous, J., Chiquet, J., Deacon, A. E., Fontrodona-Eslava, A.,
277-
Fraser, D. F. and Magurran, A. E. A JSDM with zero-inflation to
278-
improve inference of association networks from count community data
279-
with structural zeros. bioRxiv preprint, 2025.
280-
[doi:10.1101/2025.07.24.666553](https://doi.org/10.1101/2025.07.24.666553)
281-
282-
[^10]: Fossheim, M., Nilssen, E. M. and Aschan, M. Fish assemblages in
283-
the Barents Sea. Marine Biology Research, 2(4), 2006.
284-
[doi:10.1080/17451000600815698](https://doi.org/10.1080/17451000600815698)
248+
<div id="refs" class="references csl-bib-body hanging-indent">
249+
250+
<div id="ref-AiH89" class="csl-entry">
251+
252+
Aitchison, J., and C. H. Ho. 1989. “The Multivariate Poisson-Log Normal
253+
Distribution.” *Biometrika* 76 (4): 643–53.
254+
255+
</div>
256+
257+
<div id="ref-ZIPLN" class="csl-entry">
258+
259+
Batardière, Bastien, Julien Chiquet, François Gindraud, and Mahendra
260+
Mariadassou. 2025. “Zero-Inflation in the Multivariate Poisson Lognormal
261+
Family.” *Statistics and Computing* 35.
262+
<https://doi.org/10.1007/s11222-025-10729-0>.
263+
264+
</div>
265+
266+
<div id="ref-PLNPCA" class="csl-entry">
267+
268+
Chiquet, Julien, Mahendra Mariadassou, and Stéphane Robin. 2018.
269+
“Variational Inference for Probabilistic Poisson PCA.” *The Annals of
270+
Applied Statistics* 12: 2674–98.
271+
272+
</div>
273+
274+
<div id="ref-chiquet2021" class="csl-entry">
275+
276+
Chiquet, Julien, Mahendra Mariadassou, and Stéphane Robin. 2021. “The
277+
Poisson-Lognormal Model as a Versatile Framework for the Joint Analysis
278+
of Species Abundances.” *Frontiers in Ecology and Evolution* 9 (March):
279+
588292. <https://doi.org/10.3389/fevo.2021.588292>.
280+
281+
</div>
282+
283+
<div id="ref-PLNnetwork" class="csl-entry">
284+
285+
Chiquet, Julien, Stephane Robin, and Mahendra Mariadassou. 2019.
286+
“Variational Inference for Sparse Network Reconstruction from Count
287+
Data.” In *Proceedings of the 36th International Conference on Machine
288+
Learning*, edited by Kamalika Chaudhuri and Ruslan Salakhutdinov, vol.
289+
97. Proceedings of Machine Learning Research. PMLR.
290+
<http://proceedings.mlr.press/v97/chiquet19a.html>.
291+
292+
</div>
293+
294+
<div id="ref-fisher1936" class="csl-entry">
295+
296+
Fisher, R. A. 1936. “The Use of Multiple Measurements in Taxonomic
297+
Problems.” *Annals of Eugenics* 7 (2): 179–88.
298+
<https://doi.org/10.1111/j.1469-1809.1936.tb02137.x>.
299+
300+
</div>
301+
302+
<div id="ref-fossheim2006" class="csl-entry">
303+
304+
Fossheim, Maria, Einar M. Nilssen, and Michaela Aschan. 2006. “Fish
305+
Assemblages in the Barents Sea.” *Marine Biology Research* 2 (4):
306+
260–69. <https://doi.org/10.1080/17451000600815698>.
307+
308+
</div>
309+
310+
<div id="ref-fraley1999" class="csl-entry">
311+
312+
Fraley, Chris, and Adrian E. Raftery. 1999. “MCLUST: Software for
313+
Model-Based Cluster Analysis.” *Journal of Classification* 16 (2):
314+
297–306. <https://doi.org/10.1007/s003579900058>.
315+
316+
</div>
317+
318+
<div id="ref-FHT08" class="csl-entry">
319+
320+
Friedman, J., T. Hastie, and R. Tibshirani. 2008. “Sparse Inverse
321+
Covariance Estimation with the Graphical Lasso.” *Biostatistics* 9 (3):
322+
432–41.
323+
324+
</div>
325+
326+
<div id="ref-ZIPLNnetwork" class="csl-entry">
327+
328+
Tous, Jeanne, Julien Chiquet, Amy E. Deacon, Ada Fontrodona-Eslava,
329+
Douglas F. Fraser, and Anne E. Magurran. 2025. “A JSDM with
330+
Zero-Inflation to Improve Inference of Association Networks from Count
331+
Community Data with Structural Zeros.”
332+
<https://doi.org/10.1101/2025.07.24.666553>.
333+
334+
</div>
335+
336+
</div>

README.qmd

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: "PLNmodels: Poisson lognormal models for multivariate count data"
33
format:
44
gfm:
55
default-image-extension: ""
6+
bibliography: vignettes/article/PLNreferences.bib
7+
link-citations: true
68
---
79

810
<!-- badges: start -->
9-
[![R-CMD-check](https://github.com/PLN-team/PLNmodels/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/PLN-team/PLNmodels/actions/workflows/R-CMD-check.yaml)
10-
[![Coverage status](https://codecov.io/gh/pln-team/PLNmodels/branch/master/graph/badge.svg)](https://codecov.io/github/pln-team/PLNmodels?branch=master)
11-
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/PLNmodels)](https://cran.r-project.org/package=PLNmodels)
12-
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html)
13-
[![](https://img.shields.io/github/last-commit/pln-team/PLNmodels.svg)](https://github.com/pln-team/PLNmodels/commits/master)
11+
12+
[![R-CMD-check](https://github.com/PLN-team/PLNmodels/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/PLN-team/PLNmodels/actions/workflows/R-CMD-check.yaml) [![Coverage status](https://codecov.io/gh/pln-team/PLNmodels/branch/master/graph/badge.svg)](https://codecov.io/github/pln-team/PLNmodels?branch=master) [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/PLNmodels)](https://cran.r-project.org/package=PLNmodels) [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html) [![](https://img.shields.io/github/last-commit/pln-team/PLNmodels.svg)](https://github.com/pln-team/PLNmodels/commits/master)
13+
1414
<!-- badges: end -->
1515

1616
```{r setup, include=FALSE}
@@ -25,26 +25,16 @@ knitr::opts_chunk$set(
2525

2626
## Description
2727

28-
> The Poisson lognormal model and variants[^1] can be used for a variety of multivariate problems when count data are at play. This package implements efficient variational algorithms to fit such models, accompanied with a set of functions for visualization and diagnostic. See [all the dedicated vignettes](https://pln-team.github.io/PLNmodels/articles/) for a comprehensive introduction.
28+
> The Poisson lognormal model and variants [@chiquet2021] can be used for a variety of multivariate problems when count data are at play. This package implements efficient variational algorithms to fit such models, accompanied with a set of functions for visualization and diagnostic. See [all the dedicated vignettes](https://pln-team.github.io/PLNmodels/articles/) for a comprehensive introduction.
2929
3030
**PLNmodels** covers the following models, all built around the multivariate Poisson-lognormal distribution and sharing a common formula-based interface (covariates, offsets, weights) and a choice of optimization backends (a fast built-in Newton solver, NLOPT, and an experimental torch backend):
3131

32-
- **PLN**[^2]: unpenalized multivariate Poisson regression, with several covariance structures (full, diagonal, spherical, fixed, or a genetic/heritability structure).
33-
- **PLNPCA**[^3]: probabilistic Poisson PCA — a rank-constrained covariance for dimension reduction and visualization.
34-
- **PLNLDA**: Poisson lognormal discriminant analysis[^4] for the supervised classification of count data.
35-
- **PLNnetwork**[^5]: sparse inverse-covariance (network) inference via a graphical-lasso-like penalty[^6].
36-
- **PLNmixture**: model-based clustering[^7] of count data via a mixture of PLN models.
37-
- **ZIPLN**[^8]: a zero-inflated extension of PLN for data with excess zeros, with the same family of covariance structures and an optional sparse (`ZIPLNnetwork`[^9]) variant.
38-
39-
[^1]: J. Chiquet, M. Mariadassou and S. Robin: The Poisson-lognormal model as a versatile framework for the joint analysis of species abundances, Frontiers in Ecology and Evolution, 2021. [doi:10.3389/fevo.2021.588292](https://www.frontiersin.org/articles/10.3389/fevo.2021.588292/full)
40-
[^2]: Aitchison, J. and Ho, C. H. The multivariate Poisson-log normal distribution. Biometrika, 76(4), 1989, 643–653.
41-
[^3]: J. Chiquet, M. Mariadassou and S. Robin: Variational inference for probabilistic Poisson PCA, the Annals of Applied Statistics, 12: 2674–2698, 2018. [doi:10.1214/18-AOAS1177](http://dx.doi.org/10.1214/18%2DAOAS1177)
42-
[^4]: Fisher, R. A. The use of multiple measurements in taxonomic problems. Annals of Eugenics, 7(2), 1936; Rao, C. R. The utilization of multiple measurements in problems of biological classification. JRSS B, 10(2), 1948.
43-
[^5]: J. Chiquet, M. Mariadassou and S. Robin: Variational inference for sparse network reconstruction from count data, Proceedings of the 36th International Conference on Machine Learning (ICML), 2019. [link](http://proceedings.mlr.press/v97/chiquet19a.html)
44-
[^6]: Friedman, J., Hastie, T. and Tibshirani, R. Sparse inverse covariance estimation with the graphical lasso. Biostatistics, 9(3), 2008.
45-
[^7]: Fraley, C. and Raftery, A. E. MCLUST: Software for model-based cluster analysis. Journal of Classification, 16(2), 1999.
46-
[^8]: Batardière, B., Chiquet, J., Gindraud, F. and Mariadassou, M. Zero-inflation in the multivariate Poisson lognormal family. Statistics and Computing, 35, 2025. [doi:10.1007/s11222-025-10729-0](https://doi.org/10.1007/s11222-025-10729-0)
47-
[^9]: Tous, J., Chiquet, J., Deacon, A. E., Fontrodona-Eslava, A., Fraser, D. F. and Magurran, A. E. A JSDM with zero-inflation to improve inference of association networks from count community data with structural zeros. bioRxiv preprint, 2025. [doi:10.1101/2025.07.24.666553](https://doi.org/10.1101/2025.07.24.666553)
32+
- **PLN** [@AiH89]: unpenalized multivariate Poisson regression, with several covariance structures (full, diagonal, spherical, fixed, or a genetic/heritability structure).
33+
- **PLNPCA** [@PLNPCA]: probabilistic Poisson PCA — a rank-constrained covariance for dimension reduction and visualization.
34+
- **PLNLDA**: Poisson lognormal discriminant analysis [@fisher1936] for the supervised classification of count data.
35+
- **PLNnetwork** [@PLNnetwork]: sparse inverse-covariance (network) inference via a graphical-lasso-like penalty [@FHT08].
36+
- **PLNmixture**: model-based clustering [@fraley1999] of count data via a mixture of PLN models.
37+
- **ZIPLN** [@ZIPLN]: a zero-inflated extension of PLN for data with excess zeros, with the same family of covariance structures and an optional sparse (`ZIPLNnetwork`) variant [@ZIPLNnetwork].
4838

4939
## Installation
5040

@@ -58,9 +48,7 @@ remotes::install_github("pln-team/PLNmodels@tag_number") # a specific tagged re
5848

5949
## Illustration
6050

61-
We illustrate the main models on the `barents` data set[^10]: the abundance of 30 fish species observed in 89 sites in the Barents sea, along with depth, temperature and geographic coordinates for each site.
62-
63-
[^10]: Fossheim, M., Nilssen, E. M. and Aschan, M. Fish assemblages in the Barents Sea. Marine Biology Research, 2(4), 2006. [doi:10.1080/17451000600815698](https://doi.org/10.1080/17451000600815698)
51+
We illustrate the main models on the `barents` data set [@fossheim2006]: the abundance of 30 fish species observed in 89 sites in the Barents sea, along with depth, temperature and geographic coordinates for each site.
6452

6553
```{r load}
6654
library(PLNmodels)

vignettes/bib/PLNreferences.bib

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,3 +276,72 @@ @article{fraley1999
276276
langid = {en}
277277
}
278278

279+
280+
@article{chiquet2021,
281+
title = {The Poisson-Lognormal Model as a Versatile Framework for the Joint Analysis of Species Abundances},
282+
author = {Chiquet, Julien and Mariadassou, Mahendra and Robin, {Stéphane}},
283+
year = {2021},
284+
month = {03},
285+
date = {2021-03-31},
286+
journal = {Frontiers in Ecology and Evolution},
287+
pages = {588292},
288+
volume = {9},
289+
doi = {10.3389/fevo.2021.588292},
290+
url = {https://www.frontiersin.org/articles/10.3389/fevo.2021.588292/full}
291+
}
292+
293+
@article{chiquet2021,
294+
title = {The Poisson-Lognormal Model as a Versatile Framework for the Joint Analysis of Species Abundances},
295+
author = {Chiquet, Julien and Mariadassou, Mahendra and Robin, {Stéphane}},
296+
year = {2021},
297+
month = {03},
298+
date = {2021-03-31},
299+
journal = {Frontiers in Ecology and Evolution},
300+
pages = {588292},
301+
volume = {9},
302+
doi = {10.3389/fevo.2021.588292},
303+
url = {https://www.frontiersin.org/articles/10.3389/fevo.2021.588292/full}
304+
}
305+
306+
@article{chiquet2021,
307+
title = {The Poisson-Lognormal Model as a Versatile Framework for the Joint Analysis of Species Abundances},
308+
author = {Chiquet, Julien and Mariadassou, Mahendra and Robin, {Stéphane}},
309+
year = {2021},
310+
month = {03},
311+
date = {2021-03-31},
312+
journal = {Frontiers in Ecology and Evolution},
313+
pages = {588292},
314+
volume = {9},
315+
doi = {10.3389/fevo.2021.588292},
316+
url = {https://www.frontiersin.org/articles/10.3389/fevo.2021.588292/full}
317+
}
318+
319+
@article{fisher1936,
320+
title = {The Use of Multiple Measurements in Taxonomic Problems},
321+
author = {Fisher, R. A.},
322+
year = {1936},
323+
month = {09},
324+
date = {1936-09},
325+
journal = {Annals of Eugenics},
326+
pages = {179--188},
327+
volume = {7},
328+
number = {2},
329+
doi = {10.1111/j.1469-1809.1936.tb02137.x},
330+
url = {http://dx.doi.org/10.1111/j.1469-1809.1936.tb02137.x},
331+
langid = {en}
332+
}
333+
334+
@article{fossheim2006,
335+
title = {Fish assemblages in the Barents Sea},
336+
author = {Fossheim, Maria and Nilssen, Einar M. and Aschan, Michaela},
337+
year = {2006},
338+
month = {08},
339+
date = {2006-08},
340+
journal = {Marine Biology Research},
341+
pages = {260--269},
342+
volume = {2},
343+
number = {4},
344+
doi = {10.1080/17451000600815698},
345+
url = {http://dx.doi.org/10.1080/17451000600815698},
346+
langid = {en}
347+
}

0 commit comments

Comments
 (0)