Browse all GraTools commands organized by category.

πŸ› οΈ View All Subcommands (CLI Output)
$ gratools
Welcome to GraTools version: '1.2.0.dev19'
@author: GraTools team's
        ____                 __________               ____          
      6MMMMMb/               MMMMMMMMMM               `MM          
     8P    YM               /   MM     \               MM          
    6M      Y ___  __    ___    MM   _____     _____   MM   ____   
    MM        `MM 6MM  6MMMMb   MM  6MMMMMb   6MMMMMb  MM  6MMMMb\ 
    MM         MM69 " 8M'  `Mb  MM 6M'   `Mb 6M'   `Mb MM MM'    ` 
    MM     ___ MM'        ,oMM  MM MM     MM MM     MM MM YM.      
    MM     `M' MM     ,6MM9'MM  MM MM     MM MM     MM MM  YMMMMb  
    YM      M  MM     MM'   MM  MM MM     MM MM     MM MM      `Mb 
     8b    d9  MM     MM.  ,MM  MM YM.   ,M9 YM.   ,M9 MM L    ,MM 
      YMMMMM9  _MM_   `YMMM9'Yb_MM_ YMMMMM9   YMMMMM9 _MM_MYMMMM9 
        \                                    /                /
        /''A''\          /''''''\           /     /''''A'''''\
  ...GC|       |..ATG...C...CG...T....TAG..'..GC.|            |...
        \..C../      \.............../            \...TATA.../
 
Please cite our gitlab: https://forge.ird.fr/diade/gratools.git\

Usage: gratools [OPTIONS] COMMAND [ARGS]...

  A toolkit for analyzing, manipulating, and extracting information from
  pangenome graphs in GFA format.

Options:
  -v, --version  Show the version and exit.
  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 
  -h, --help     Show this message and exit.

GFA Content Information:
  list_samples (samples)
     List the samples embedded in the imported GFA file.

  list_chr (chr)
     List the embedded chromosomes and their fragments if relevant from the
     imported GFA file.

  stats
     Compute and display various statistics for a GFA file.

GFA Data Extraction:
  get_subgraph (subgraph)
     Extracts a subgraph from a GFA file based on a query region.

  get_fasta (fasta)
     Extracts sequences for a specific genomic region in FASTA format.

  to_bandage
     Generates a CSV file for the Bandage graph visualizer.

GFA Analysis:
  pan_ratio (ratio)
     Compute and display the ratio of core and dispensable segments.

  depth_nodes_stat (dns)
     Display various statistics about segment depth (number of embedded
     samples).

  specific_groups_sample (groups)
     Identify segments shared by or specific to defined sample groups.

  get_segments_by_depth (depth)
     List segments within a specified depth range (number of encompassing
     samples).

Other commands:
  import
     Pre-processes a GFA file for faster GraTools operations.

  shell_completion
     Generates shell completion scripts (Bash, Zsh, Fish).

GFA Content

πŸ“Š 3 commands

Explore samples, chromosomes, and graph statistics.

Data Extraction

βœ‚οΈ 2 commands

Extract subgraphs and FASTA sequences.

GFA Analysis

πŸ”¬ 4 commands

Core/dispensable, depth, and group comparisons.

Other

βš™οΈ 2 commands

Import and shell completion.


GFA Content Information

πŸ“ˆ stats

Compute and display various statistics for a GFA file.

gratools stats
πŸ‘₯ list_samples

List all unique samples embedded in the GFA file.

gratools list_samples
🧬 list_chr

List chromosomes and fragments per sample.

gratools list_chr

GFA Data Extraction

πŸ—ΊοΈ get_subgraph

Extract a subgraph from a GFA file based on a query region.

gratools get_subgraph
πŸ“‘ get_fasta

Extract sequences for a specific genomic region in FASTA format.

gratools get_fasta

GFA Analysis

βš–οΈ pan_ratio

Compute the ratio of core and dispensable segments.

gratools pan_ratio
πŸ“‰ depth_nodes_stat

Display statistics about segment depth across samples.

gratools depth_nodes_stat
🧬 specific_groups_sample

Identify segments shared by or specific to sample groups.

gratools specific_groups_sample
πŸ”Ž get_segments_by_depth

List segments within a specified depth range.

gratools get_segments_by_depth

Other Commands

πŸ—‚οΈ import

Pre-process a GFA file for faster GraTools operations. Run this first.

gratools import
πŸ–₯️ shell_completion

Generate shell completion scripts for Bash, Zsh, and Fish.

gratools shell_completion

πŸ’‘ New to GraTools?

Start with the πŸ“¦ Installation to understand the typical workflow, or explore the 1 β€” Graph Description for real-world biological examples.