Skip to main content

A utility for creating sashimi plot from Shiba output

Project description

GitHub License GitHub Release GitHub Release Date Create Release

🐕 shiba2sashimi 🍣 (v0.1.0)

A utility to create Sashimi plots, a publication-quality visualization of RNA-seq data, from Shiba output. Greatly inspired by rmats2sashimiplot and MISO's original implementation.

Quick start

shiba2sashimi -e /path/to/Shiba/experiment_table.tsv \
-s /path/to/Shiba/output/ -o img/sashimi_example.png \
--id "SE@chr11@5091460-5091477@5088146-5091859"

How to install

pip install shiba2sashimi

or

git clone https://github.com/NaotoKubota/shiba2sashimi.git
cd shiba2sashimi
pip install .

You can run the script without pip installing by running the script directly.

git clone https://github.com/NaotoKubota/shiba2sashimi.git
cd shiba2sashimi
python -m shiba2sashimi.main

Dependencies

  • numpy (>=1.18.0,<2.0.0)
  • matplotlib (>=3.1.0)
  • pysam (>=0.22.0)

Usage

usage: shiba2sashimi [-h] -e EXPERIMENT -s SHIBA -o OUTPUT [--id ID] [-c COORDINATE] [--samples SAMPLES] [--groups GROUPS] [--colors COLORS] [--extend_up EXTEND_UP] [--extend_down EXTEND_DOWN]
                     [--smoothing_window_size SMOOTHING_WINDOW_SIZE] [--font_family FONT_FAMILY] [--dpi DPI] [-v]

shiba2sashimi v0.1.0 - Create Sashimi plot from Shiba output

optional arguments:
  -h, --help            show this help message and exit
  -e EXPERIMENT, --experiment EXPERIMENT
                        Experiment table used for Shiba
  -s SHIBA, --shiba SHIBA
                        Shiba output directory
  -o OUTPUT, --output OUTPUT
                        Output file
  --id ID               Positional ID (pos_id) of the event to plot
  -c COORDINATE, --coordinate COORDINATE
                        Coordinates of the region to plot
  --samples SAMPLES     Samples to plot. e.g. sample1,sample2,sample3 Default: all samples in the experiment table
  --groups GROUPS       Groups to plot. e.g. group1,group2,group3 Default: all groups in the experiment table. Overrides --samples
  --colors COLORS       Colors for each group. e.g. red,orange,blue
  --extend_up EXTEND_UP
                        Extend the plot upstream. Only used when not providing coordinates. Default: 500
  --extend_down EXTEND_DOWN
                        Extend the plot downstream. Only used when not providing coordinates. Default: 500
  --smoothing_window_size SMOOTHING_WINDOW_SIZE
                        Window size for median filter to smooth coverage plot. Greater value gives smoother plot. Default: 21
  --font_family FONT_FAMILY
                        Font family for labels
  --dpi DPI             DPI of the output figure. Default: 300
  -v, --verbose         Increase verbosity

Authors

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

shiba2sashimi-0.1.0.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

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

shiba2sashimi-0.1.0-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shiba2sashimi-0.1.0.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.7

File hashes

Hashes for shiba2sashimi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 59bc15ffd8a9b81527aa4e1aa73cad6b1cf11952ee9c9a661c6cfbc3a0903a8c
MD5 848ec5237fa53393d0a55b33681e544b
BLAKE2b-256 629de9154a44b439a7396a853d51b621f139fd40f01b2bfe863e3d5ae61ed32e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shiba2sashimi-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.7

File hashes

Hashes for shiba2sashimi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a975957e934f4147307dd516d1908e073023cba57f1a73d5a7c43f69d8ae6af
MD5 bd0bbd1d2dd1bce793c569af20b069e1
BLAKE2b-256 62ff532efb03bed7bfd0dcec67712b5ee2ec558a6d9883cfdc419603fa01265a

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