Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,38 @@ preferred-citation:
url: "https://doi.org/10.1371/journal.pcbi.1007732"

references:
- type: article
title: "PPanGGOLiN V2: technical enhancement and extended functionalities for prokaryotic pangenome analysis"
authors:
- family-names: Arnoux
given-names: Jérôme
orcid: https://orcid.org/0000-0003-2769-3006
- family-names: Mainguy
given-names: Jean
orcid: https://orcid.org/0009-0006-9160-9744
- family-names: Bazin
given-names: Adelme
orcid: https://orcid.org/0000-0002-5656-4708
- family-names: Gautreau
given-names: Guillaume
orcid: https://orcid.org/0000-0002-0970-9361
- family-names: Lemane
given-names: Téo
orcid: https://orcid.org/0000-0002-7210-3178
- family-names: Vallenet
given-names: David
orcid: https://orcid.org/0000-0001-6648-0332
- family-names: Calteau
given-names: Alexandra
orcid: https://orcid.org/0000-0002-5871-9347
journal: "Journal of Open Source Software"
volume: 11
issue: 127
start: 11101
year: 2026
doi: "10.21105/joss.11101"
url: "https://doi.org/10.21105/joss.11101"

- type: article
title: "panRGP: a pangenome-based method to predict genomic islands and explore their diversity"
authors:
Expand Down
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# PPanGGOLiN: Depicting microbial species diversity via a Partitioned PanGenome Graph Of Linked Neighbors

[![Actions](https://img.shields.io/github/actions/workflow/status/labgem/PPanGGOLiN/main.yml?branch=master&label=CI&logo=github)](https://github.com/labgem/PPanGGOLiN/actions/workflows/main.yml)
[![License](https://anaconda.org/bioconda/ppanggolin/badges/license.svg)](http://www.cecill.info/licences.fr.html)
[![JOSS](https://joss.theoj.org/papers/10.21105/joss.11101/status.svg)](https://doi.org/10.21105/joss.11101)
[![PLOS Comp Biol](https://img.shields.io/badge/PLOS_Comp_Biol-10.1371%2Fjournal.pcbi.1007732-blue?style=flat-square)](https://doi.org/10.1371/journal.pcbi.1007732)

[![Bioconda](https://img.shields.io/conda/vn/bioconda/ppanggolin?style=flat-square&maxAge=3600&logo=anaconda)](https://anaconda.org/bioconda/ppanggolin)
[![PyPI version](https://badge.fury.io/py/PPanGGOLiN.svg?cache-control=no-cache)](https://pypi.org/project/PPanGGOLiN/)
[![PyPI version](https://img.shields.io/pypi/v/PPanGGOLiN?style=flat-square&logo=pypi)](https://pypi.org/project/PPanGGOLiN/)
[![Downloads](https://img.shields.io/conda/dn/bioconda/ppanggolin?style=flat-square&label=conda%20downloads)](https://bioconda.github.io/recipes/ppanggolin/README.html#download-stats)

[![CI](https://img.shields.io/github/actions/workflow/status/labgem/PPanGGOLiN/main.yml?branch=master&label=CI&logo=github&style=flat-square)](https://github.com/labgem/PPanGGOLiN/actions/workflows/main.yml)
[![Docs](https://img.shields.io/readthedocs/ppanggolin/latest?style=flat-square&maxAge=600)](https://ppanggolin.readthedocs.io)
[![Source](https://img.shields.io/badge/source-GitHub-303030.svg?maxAge=2678400&style=flat-square)](https://github.com/labgem/ppanggolin/)
[![GitHub issues](https://img.shields.io/github/issues/labgem/ppanggolin.svg?style=flat-square&maxAge=600)](https://github.com/labgem/ppanggolin/issues)
[![Docs](https://img.shields.io/readthedocs/ppanggolin/latest?style=flat-square&maxAge=600)](https://ppanggolin.readthedocs.io)
[![Downloads](https://anaconda.org/bioconda/ppanggolin/badges/downloads.svg)](https://bioconda.github.io/recipes/ppanggolin/README.html#download-stats)
[![License](https://img.shields.io/badge/license-CeCILL--2.1-green?style=flat-square)](http://www.cecill.info/licences.fr.html)

**PPanGGOLiN**
([Gautreau et al. 2020](https://doi.org/10.1371/journal.pcbi.1007732)) is a software suite used to create and manipulate prokaryotic pangenomes from a set of either genomic DNA sequences or provided genome annotations.
([Gautreau et al. 2020](https://doi.org/10.1371/journal.pcbi.1007732); [Arnoux et al. 2026](https://doi.org/10.21105/joss.11101)) is a software suite used to create and manipulate prokaryotic pangenomes from a set of either genomic DNA sequences or provided genome annotations.
It is designed to scale up to tens of thousands of genomes.
It has the specificity to partition the pangenome using a statistical approach rather than using fixed thresholds which gives it the ability to work with low-quality data such as *Metagenomic Assembled Genomes (MAGs)* or *Single-cell Amplified Genomes (SAGs)* thus taking advantage of large scale environmental studies and letting users study the pangenome of uncultivable species.

Expand Down Expand Up @@ -124,6 +128,11 @@ We cannot correct bugs if we do not know about them, and will try to help you th
# Citation
If you use this tool for your research, please cite:

> **PPanGGOLiN V2: technical enhancement and extended functionalities for prokaryotic pangenome analysis**
> Arnoux et al. (2026)
> *Journal of Open Source Software, 11(127), 11101*
> doi: [10.21105/joss.11101](https://doi.org/10.21105/joss.11101)

> **PPanGGOLiN: Depicting microbial diversity via a partitioned pangenome graph**
> Gautreau G et al. (2020)
> *PLOS Computational Biology 16(3): e1007732.*
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@


**PPanGGOLiN**
([Gautreau et al. 2020](https://doi.org/10.1371/journal.pcbi.1007732)) is a software suite used to create and manipulate prokaryotic pangenomes from a set of either assembled genomic DNA sequences or provided genome annotations.
([Gautreau et al. 2020](https://doi.org/10.1371/journal.pcbi.1007732); [Arnoux et al. 2026](https://doi.org/10.21105/joss.11101)) is a software suite used to create and manipulate prokaryotic pangenomes from a set of either assembled genomic DNA sequences or provided genome annotations.
It is designed to scale up to tens of thousands of genomes.
It has the specificity to partition the pangenome using a statistical approach rather than using fixed thresholds which gives it the ability to work with low-quality data such as *Metagenomic Assembled Genomes (MAGs)* or *Single-cell Amplified Genomes (SAGs)* thus taking advantage of large scale environmental studies and letting users study the pangenome of uncultivable species.

Expand Down
3 changes: 3 additions & 0 deletions docs/user/practicalInformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ Before reporting a bug, if possible please add the option `--verbose 2` to your
## Citation
If you use this tool for your research, please cite:

Arnoux et al. (2026) **PPanGGOLiN V2**: technical enhancement and extended functionalities for prokaryotic pangenome analysis.
Journal of Open Source Software, 11(127), 11101. <https://doi.org/10.21105/joss.11101>

Gautreau G et al. (2020) **PPanGGOLiN**: Depicting microbial diversity via a partitioned pangenome graph.
PLOS Computational Biology 16(3): e1007732. <https://doi.org/10.1371/journal.pcbi.1007732>

Expand Down
2 changes: 1 addition & 1 deletion docs/user/whatsNewInV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

PPanGGOLiN v2 is the result of the work carried out since mid-2021, released under version numbers `2.0.0` and above from January 2024 onwards. This page summarizes what changed with respect to PPanGGOLiN as originally published ([Gautreau et al. 2020](https://doi.org/10.1371/journal.pcbi.1007732)), as well as panRGP ([Bazin et al. 2020](https://doi.org/10.1093/bioinformatics/btaa792)) and panModule ([Bazin et al. 2021](https://doi.org/10.1101/2021.12.06.471380)), taking release `1.1.136` (February 2021) as the reference point. It is intended for users coming from a v1 release who want to know what is new and what has moved.

The features listed below were released progressively, and some of them are already available in the later `1.2.x` releases. The major version number was raised to `2.0.0` at the point where the redesigned pangenome file broke compatibility with the HDF5 files produced by v1, marking the boundary between the two versions. The rationale behind these changes is described in the PPanGGOLiN v2 publication.
The features listed below were released progressively, and some of them are already available in the later `1.2.x` releases. The major version number was raised to `2.0.0` at the point where the redesigned pangenome file broke compatibility with the HDF5 files produced by v1, marking the boundary between the two versions. The rationale behind these changes is described in the PPanGGOLiN v2 publication ([Arnoux et al. 2026](https://doi.org/10.21105/joss.11101)).

## New analyses

Expand Down
12 changes: 9 additions & 3 deletions ppanggolin/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,25 @@
PPanGGOLiN ({version}) is an open-source bioinformatics tool developed by the LABGeM team, and distributed under the CeCILL Free Software License Agreement.
"""

v2_epilog = """
If you use PPanGGOLiN, please cite:
Arnoux J et al. (2026) PPanGGOLiN V2: technical enhancement and extended functionalities for prokaryotic pangenome analysis.
Journal of Open Source Software, 11(127), 11101. https://doi.org/10.21105/joss.11101
"""

pan_epilog = """
For pangenome analyses, please cite:
For pangenome analyses, please also cite:
Gautreau G et al. (2020) PPanGGOLiN: Depicting microbial diversity via a partitioned pangenome graph.
PLOS Computational Biology 16(3): e1007732. https://doi.org/10.1371/journal.pcbi.1007732
"""
rgp_epilog = """
For genomic islands and spots of insertion detection, please cite:
For genomic islands and spots of insertion detection, please also cite:
Bazin A et al. (2020) panRGP: a pangenome-based method to predict genomic islands and explore their diversity.
Bioinformatics, Volume 36, Issue Supplement_2, Pages i651–i658, https://doi.org/10.1093/bioinformatics/btaa792
"""

mod_epilog = """
For module prediction, please cite:
For module prediction, please also cite:
Bazin A et al. (2021) panModule: detecting conserved modules in the variable regions of a pangenome graph.
bioRxiv. https://doi.org/10.1101/2021.12.06.471380
"""
5 changes: 3 additions & 2 deletions ppanggolin/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
mod_epilog,
pan_epilog,
rgp_epilog,
v2_epilog,
version,
)
from ppanggolin.utils import (
Expand Down Expand Up @@ -94,7 +95,7 @@ def build_parser() -> argparse.ArgumentParser:
prog="ppanggolin",
description="Depicting microbial species diversity via a Partitioned PanGenome Graph Of Linked Neighbors",
formatter_class=RawTextHelpFormatterWithDefaults,
epilog=epilog + pan_epilog + rgp_epilog + mod_epilog,
epilog=epilog + v2_epilog + pan_epilog + rgp_epilog + mod_epilog,
)

parser.add_argument(
Expand All @@ -109,7 +110,7 @@ def build_parser() -> argparse.ArgumentParser:
for sub_cmd, sub_fct in SUBCOMMAND_TO_SUBPARSER.items():
sub = sub_fct(subparsers)
add_common_arguments(sub)
sub.epilog = epilog
sub.epilog = epilog + v2_epilog
if sub_cmd not in ["rgp", "spot", "module", "rgp_cluster"]:
sub.epilog += pan_epilog
if sub_cmd not in [
Expand Down
Loading