GraTools Logo

a powerful tool for analyzing pangenome graphs

Analyze and handle pangenome graphs quickly, whatever the model, size, or complexity.

πŸš€ High Performance

Multi-threading support for fast analysis of large GFA files, regardless of model complexity.

πŸ› οΈ Versatile Toolkit

Extract sequences, subgraphs, convert to FASTA, and identify shared/specific nodes.

πŸ“Š Deep Statistics

Generate essential statistics for chromosomes, samples, and core/dispensable ratios.

β€”

What’s GraTools?

GraTools offers a set of commands designed for rapid analysis of pangenome graphs. It provides an efficient solution for researchers to explore GFA files, providing insights into genome structure and sample relationships.

Developed by IRD and CIRAD, as part of a collaboration between the PANEEC/DIADE and PHIM research teams.

β€”

πŸš€ Quick Start Guide

This guide will help you get up and running with GraTools in no time.

πŸ“¦ Installation

β€”

🧬 Use Case 1 β€” Graph Description

Explore the content of a PVG: basic statistics, sample listing, and chromosome/contig inventory using stats, list_samples and list_chr.

1 β€” Graph Description
πŸ” Use Case 2 β€” Subgraph & FASTA Extraction

Extract a subgraph or FASTA sequences for any genomic locus, using coordinates from any embedded haplotype β€” no re-indexing required.

2 β€” Subgraph & FASTA Extraction
πŸ“Š Use Case 3 β€” Core/Dispensable & Subspecies Groups

Compute the core vs. dispensable genome ratio and identify nodes specific to one group of samples compared to another with pan_ratio and groups.

3 β€” Core/Dispensable & Groups
βš™οΈ Use Case 4 β€” Advanced Pangenome Size Analysis

Power-user workflow: compute subspecies-specific pangenome sizes in bp by combining groups output with the GraTools BAM file via the pysam API.

4 β€” Advanced Pangenome Size Analysis

β€”

πŸ“– Advanced Usage

Explore the full potential of GraTools with detailed command documentation.

πŸ’» For Developers

Access the module documentation and API details for integration.

β€”

Usage Syntax

GraTools follows a simple command-line interface:

GraTools [command] [options]

Example: List chromosomes per sample in a GFA file:

GraTools show_chr --gfa graph.gfa --full

β€”

πŸ“‘ Documentation Navigation

β€”

Authors & Acknowledgments

πŸ‘₯ Development Team
  • SΓ©bastien RAVEL (PHIM, CIRAD)

  • Camille CARRETTE (DIADE, IRD/SYNGENTA)

  • Nina MARTHE (DIADE, IRD)

  • Mohamed MOURDAS (DIADE, IRD)

  • FranΓ§ois SABOT (DIADE, IRD)

  • Christine TRANCHANT (DIADE, IRD)

🀝 Acknowledgments & Contact

β€”

License

βš–οΈ GPLv3 License

GraTools is freely available under the GNU General Public License, version 3 (GPLv3). Intellectual property belongs to IRD and CIRAD.

β€”

Indices and tables