Skip to main content

Package for generating genomics figures.

Project description

figeno

  FIGENO is a
  FIGure
    GENerator
for GENOmics

With figeno, you can plot various types of sequencing data along genomic coordinates.

figeno Example figures generated with figeno. Left: allele-specific methylation with nanopore data. Right: HiC data across a structural rearrangement. See more examples here

Features

  • Large collection of tracks (bigwig, HiC, alignments with base modifications, WGS with copy numbers and SV…)
  • Multi-region figures with interactions across regions
  • Graphical user interface, command line interface and python API
  • Output figures in vector graphics (svg, pdf) or bitmap (png)

Quick start

Linux, MacOS

In an environment with python>=3.7:

pip install figeno
figeno gui

This will install figeno and run the graphical user interface (GUI). From the GUI, you can configure the figure and generate it, as well as save the JSON config file which fully defines the figure. The GUI is optional and you can instead use the command line interface: use figeno init to initialize a config file, edit the config file manually, and generate the figure with figeno make.

Windows

Download figeno_windows.zip from https://github.com/CompEpigen/figeno/releases/latest, unzip it and launch the graphical user interface by executing figeno.exe.

Documentation

For more information on how to use figeno, please read the documentation at: https://figeno.readthedocs.io/en/latest/

Test data

Example input files to test figeno are provided in test_data.

Feedback

If you encounter a bug or would like to have a new feature added, please do not hesitate to raise an issue or to contact me directly. You can also provide feedback by completing this anonymous form, which would help me improve figeno!

Citation

If you use figeno in your research, we would appreciate it if you would cite the manuscript describing figeno:

Etienne Sollier, Jessica Heilmann, Clarissa Gerhauser, Michael Scherer, Christoph Plass, Pavlo Lutsik. Figeno: multi-region genomic figures with long-read support. doi:10.1101/2024.04.22.590500.

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

figeno-1.2.0.tar.gz (18.0 MB view details)

Uploaded Source

Built Distribution

figeno-1.2.0-py3-none-any.whl (18.1 MB view details)

Uploaded Python 3

File details

Details for the file figeno-1.2.0.tar.gz.

File metadata

  • Download URL: figeno-1.2.0.tar.gz
  • Upload date:
  • Size: 18.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.16

File hashes

Hashes for figeno-1.2.0.tar.gz
Algorithm Hash digest
SHA256 c1357ffc7077ca764c22a6b756d55e37ffd22fce7becfbb8710af179a818df50
MD5 ea0d611e3d52e6a28b128f6e15f90143
BLAKE2b-256 e6e92d3a0e066a2b2313617b30d92f36286bd4cbe7b839cf014e33344af54ce7

See more details on using hashes here.

File details

Details for the file figeno-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: figeno-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.16

File hashes

Hashes for figeno-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f9cb608a4b4ff795e728ef352d0b92f22c0e462581f90408cb12205eff0109bf
MD5 d935569e6819d60319a99601a00d67f6
BLAKE2b-256 20b72d53a7ecbab4c765109f5ff6969ab7359fd619de650d02b60c7388bb0865

See more details on using hashes here.

Supported by

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