Skip to main content

karyoplot: annotations along the genome

Project description

karyoplot

What is karyoplot ?

karyoplot is a python package developed to draw simple karyoplot/ideogram with a simple configuration file like Circos [1], without any lines of code like karyoploteR [2]. karyoplot deals with conventional bioinformatics formats (.bed, .fasta, .gff, .gtf, .vcf, ...) to avoid file manipulations before drawing.

How does it work ?

karyoplot takes as an argument a configuration file with different sections which will have a sequence Fasta file as reference for ideograms. Every plot to draw on reference sequences is described in a track section with link to associated data and drawing options. karyoplot is mainly based on matplotlib for graph rendering and pysam for bioinformatics file format parsing.

karyoplot is under developpement, currently supported format are:

  • fasta
  • bed

available soon:

  • gff
  • vcf
  • bam
  • wig/bigWig

Install

create your virtual env in a dedicated directory

python3 -m venv $HOME/myvenvs/karyoplot

set up the new env

source $HOME/myvenvs/karyoplot/bin/activate

install karyoplot

pip install karyoplot 

enjoy

karyoplot -h

to leave the env

deactivate

Usage

Simple usage

karyoplot config.ini -o genome_karyo.png -v 2

The config.ini file is a configuration file in Microsoft Windows INI style, readable by the configparser Python module. Some sections are expected with defined options to customize your plot. See the associated documentation here for full options and required sections/options.

karyoplot

Support

For any request please contact nicolas.lapalu[at]inrae.fr or adeline.simon[at]inrae.fr

Authors and acknowledgment

  • Rosanne Phebe
  • Nicolas Lapalu
  • Adeline Simon

License

licensed under GNU General Public License v3.0

References

  • [1] Krzywinski, M. et al. Circos: an Information Aesthetic for Comparative Genomics. Genome Res (2009) 19:1639-1645
  • [2] Bernat Gel & Eduard Serra. (2017). karyoploteR: an R/Bioconductor package to plot customizable genomes displaying arbitrary data. Bioinformatics, 31–33. doi:10.1093/bioinformatics/btx346

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

karyoplot-0.1.0.tar.gz (20.9 kB view details)

Uploaded Source

Built Distribution

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

karyoplot-0.1.0-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: karyoplot-0.1.0.tar.gz
  • Upload date:
  • Size: 20.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for karyoplot-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3f535c8553005b4f8c9ff32fdcb0864fa3b164d8e9b1281cb23ce07fe4d55354
MD5 b245e977a21559171e3d5412469be27d
BLAKE2b-256 e81ef8acb78f5033381c213a8d3136cf89811f07b0b9729fd887aeda0d1a7fcc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: karyoplot-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for karyoplot-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec772fc587b60cc17152a95e43e3b675b3b80847ab6f45fcd3b093cae56a1595
MD5 8d1fecc19a159cb78fd0777cef30ca77
BLAKE2b-256 5f393c4073cfe6c7c6ef5e1247b2917ce6d7ac837535f8d8dadfcdb37a9b9a7b

See more details on using hashes here.

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