GraTools Logo

Quick Start Guide

  • ๐Ÿš€ Quick Start Guide
    • ๐Ÿ“ฆ Installation
    • ๐Ÿ› ๏ธ Command Overview
    • ๐Ÿ“– Command Examples
    • ๐Ÿ”„ Typical Workflow
    • ๐Ÿงช Testing GraTools
    • โš ๏ธ Troubleshooting
    • ๐Ÿ†˜ Further Assistance

Advanced Usage

  • All commands
    • ๐Ÿš€ CLI Overview
    • ๐Ÿ“š Command Reference
      • Core Operations
      • GFA Content Information
      • GFA Data Extraction
      • GFA Pangenome Analysis
  • index
    • Options
    • Usage Examples
    • What happens during Indexing?
  • stats
    • Options
    • Usage Examples
    • Metrics Explained
  • list_samples
    • Options
    • Usage Example
  • list_chr
    • Options
    • Usage Examples
    • Output Formats Explained
  • extract_subgraph
    • Options
    • Usage Examples
    • Illustrated Process
    • The --merge-dist Parameter
  • get_fasta
    • Options
    • Usage Examples
    • Illustrated Process
  • core_dispensable_ratio
    • Options
    • Usage Example
    • Understanding the Results
    • Process & Logic
  • get_segment_by_depth
    • Options
    • Illustrated Use Cases
      • Rare Segments Extraction
      • Core Segments Extraction
    • Logic & Parameters
  • depth_nodes_stat
    • Options
    • Usage Example
    • Understanding the Table
  • specific_groups_sample
    • Options
    • Complete Usage Example
      • Step 1: Prepare Input Lists
      • Step 2: Run Analysis
      • Step 3: Review Results
    • ๐Ÿ“‚ Output Files Detail
    • Visual Logic
  • shell_completion
    • Options
    • ๐Ÿš€ Setup Instructions
      • Step 1: Generate the Script
      • Step 2: Configure your Shell
      • Step 3: Reload Configuration
    • ๐ŸŽฎ How to Use it

GraTools for developers

  • Developer API Reference
    • ๐Ÿš€ Quick Navigation
    • ๐Ÿ—๏ธ Core Graph Engine
    • ๐Ÿ“Š Analysis & Extraction
    • ๐Ÿš€ System & CLI
    • ๐Ÿ› ๏ธ Other Commands & Utilities
    • ๐Ÿ’ก Development Guide
    • ๐Ÿ› ๏ธ Implementation Example
    • ๐Ÿ“š Project Resources
GraTools
  • Overview: module code

All modules for which code is available

  • gratools.Graph
  • gratools.Gratools
  • gratools.gfa_extract
  • gratools.logger_config
  • gratools.useful_function

© Copyright 2024โ€“2026, Sebastien Ravel (PHIM, CIRAD), Christine Tranchant-Dubreuil (DIADE, IRD), Camille Carrette (DIADE, IRD/SYNGENTA), Nina Marthe (DIADE, IRD), Mohamed Mourdas (DIADE, IRD), Franรงois Sabot (DIADE, IRD).