Skip to main content

A utility for creating sashimi plot from Shiba output

Project description

🐕 shiba2sashimi 🍣 (v0.1.3)

GitHub License DOI GitHub Release GitHub Release Date Create Release Publish PyPI Python PyPI Conda Docker Pulls Docker Image Size

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@chr2@157561213-157561293@157560260-157561542"

Sashimi plot example

How to install

pip

pip install shiba2sashimi

or

git clone https://github.com/Sika-Zheng-Lab/shiba2sashimi.git
cd shiba2sashimi
pip install .

conda

conda create -n shiba2sashimi python=3.9
conda activate shiba2sashimi
conda install -c bioconda shiba2sashimi

Docker

docker pull naotokubota/shiba2sashimi

Dependencies

  • python (>=3.9)
  • 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.3 - 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.3.tar.gz (12.3 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.3-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for shiba2sashimi-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a5f4274fe0c7c4110b82c14766a79965080c38e8975555577dc3bfc05c1efad6
MD5 e9361edd2e860f1a2f859944d318eb67
BLAKE2b-256 cea7102706c1c2a6a799365251cf037f73767f1df7acc98f9bfebb5ecb37a7a2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for shiba2sashimi-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c6ea432ae6a764d18612ffa067a12e9a4a812a379906b8ec70c051046a4c5d46
MD5 5c63f25329724e69738cf80fb518c059
BLAKE2b-256 bc92c96a95ddef771796ef761888cf782d197ca09f71b6015c05f46135b050ba

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