Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Binx Logo

Welcome to Binx!

License: GPL v3 CI

Binx is a Rust command-line genomics workbench for diploid and polyploid species. It targets GWAS and related analyses with a familiar UX: fast defaults, explicit inputs, and clear outputs.

What can Binx do?

Binx provides a suite of tools for genomic analysis:

CommandDescription
binx gwasGWASpoly-style GWAS with multiple genetic models
binx kinshipCompute kinship matrix (VanRaden method)
binx dosageEstimate genotype dosages from read counts
binx convertConvert VCF to other formats
binx plotGenerate Manhattan, QQ, or LD decay plots
binx qtlIdentify significant QTLs from GWAS results
binx thresholdCalculate significance thresholds

Key Features

  • GWASpoly-style GWAS with eight genetic models for polyploids, validated against R/GWASpoly
  • Accurate mixed model fitting via rrblup-rs, a Rust implementation of R/rrBLUP’s mixed.solve
  • Genotype dosage estimation from VCF or read count data using R/Updog-based algorithms
  • Polyploid-aware: supports ploidy levels 2, 4, 6, etc.
  • LOCO support: Leave-One-Chromosome-Out analysis
  • Multi-environment trials: handles repeated phenotype IDs

Quick Example

# Convert VCF to GWASpoly format
binx convert --vcf samples.vcf.gz --format gwaspoly --output genotypes.tsv

# Run GWAS with multiple genetic models
binx gwas \
  --geno genotypes.tsv \
  --pheno phenotypes.csv \
  --trait yield \
  --ploidy 4 \
  --models additive,general \
  --out gwas_results.csv

# Create a Manhattan plot
binx plot \
  --input gwas_results.csv \
  --plot-type manhattan \
  --model additive \
  --output gwas_manhattan.svg

Getting Started

New to Binx? Start here:

  1. Installation - Download and install Binx
  2. Quick Start - Run your first analysis in minutes
  3. Input Formats - Understand the data formats

Tutorials

Learn Binx through practical examples:

Why Binx?

Binx was created to bring the power of R/GWASpoly and R/rrBLUP to the command line with:

  • Speed: Written in Rust for fast execution
  • Reproducibility: Explicit parameters and deterministic outputs
  • Validation: Results match R implementations to 4-6 decimal places
  • Simplicity: No R environment or dependencies required

Getting Help

License

Binx is released under the GPL-3.0 license.