Skip to main content

A web-based visualization tool for genetics cohort data

Project description

Genetics-Viz 🧬

A web-based visualization tool for genetics cohort data.

Features

  • Browse multiple cohorts from a single data directory
  • View family structures and pedigree information
  • Interactive data tables with sorting and filtering
  • Clean, modern web interface built with NiceGUI

Installation

From PyPI (when published)

pip install genetics-viz

From source

# Clone the repository
git clone https://github.com/fcliquet/genetics-viz.git
cd genetics-viz

# Install with uv
uv sync

# Or install with pip
pip install -e .

Usage

# Start the web application
genetics-viz /path/to/data/directory

# With custom host and port
genetics-viz /path/to/data/directory --host 0.0.0.0 --port 8000

# With auto-reload for development
genetics-viz /path/to/data/directory --reload

Data Directory Structure

The data directory should have the following structure:

data_directory/
└── cohorts/
    ├── cohort1/
    │   └── cohort1.pedigree.tsv
    ├── cohort2/
    │   └── cohort2.pedigree.tsv
    └── ...

Pedigree File Format

Pedigree files should be tab-separated with the following columns. The header is optional - if present, it must start with "FID":

With header:

FID IID PAT MAT SEX PHENOTYPE
FAM001 IND001 0 0 M affected

Without header (positional columns):

FAM001 IND001 0 0 M affected
Column Possible Names (case-insensitive)
Family ID FID, family_id, familyid, family
Individual ID IID, individual_id, sample_id, sample
Father ID PAT, father_id, fatherid, father
Mother ID MAT, mother_id, motherid, mother
Sex SEX, gender
Phenotype PHENOTYPE, affected, status

Development

# Install development dependencies
uv sync --dev

# Run tests
uv run pytest

# Run linter
uv run ruff check .

# Format code
uv run ruff format .

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

genetics_viz-0.1.0.tar.gz (62.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

genetics_viz-0.1.0-py3-none-any.whl (85.4 kB view details)

Uploaded Python 3

File details

Details for the file genetics_viz-0.1.0.tar.gz.

File metadata

  • Download URL: genetics_viz-0.1.0.tar.gz
  • Upload date:
  • Size: 62.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for genetics_viz-0.1.0.tar.gz
Algorithm Hash digest
SHA256 27d0327bb197df510cf65079c43e20591ae08332ecd2b4b0431b68c53d477d42
MD5 b3a503618e8a614fc82ed9f2cdd808f6
BLAKE2b-256 4a2c6493cffb1c3a04123334df2d1b454d140833ededc0f5f0194ecee7674146

See more details on using hashes here.

Provenance

The following attestation bundles were made for genetics_viz-0.1.0.tar.gz:

Publisher: publish.yml on bourgeron-lab/genetics-viz

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file genetics_viz-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: genetics_viz-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 85.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for genetics_viz-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2faa4b2822bc7df234439455d3d0454005a4f7dbd5994ad7b9a4fa87196cafcd
MD5 96e4721e7d4e865e3fde10d95239c234
BLAKE2b-256 bc3711a86327de70c9f48b00562e0bd2d5ac5795521827daddcf4cf58bae1f3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for genetics_viz-0.1.0-py3-none-any.whl:

Publisher: publish.yml on bourgeron-lab/genetics-viz

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page