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.0.3.tar.gz (20.7 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.0.3-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: karyoplot-0.0.3.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for karyoplot-0.0.3.tar.gz
Algorithm Hash digest
SHA256 df0e9b47a8f51d5a800913021a6094855e09172e54c23f241bd23cdb8365ce67
MD5 0ebfa63b92db4ab7bf20557a3e5b4e40
BLAKE2b-256 3b7ff4006dbba3527eb66ffda422d7e32594d3b8447d1e157687abb2b81a788f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: karyoplot-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for karyoplot-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e233a3363da452132fbaf0b0e1365f00c5b7f4937f5e32e07a0c623b6bb40df1
MD5 8690bca7760f2adf87814ea761963a6a
BLAKE2b-256 90106ae0914125afb9a5a51fa18d506f8715786e38eb76eba5f24fe899457bf2

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