Skip to main content

A utility for creating sashimi plot from Shiba output

Project description

🐕 shiba2sashimi 🍣 (v0.1.4)

GitHub License DOI GitHub Release GitHub Release Date Create Release Publish PyPI Python PyPI PyPI - Downloads Conda Conda - Downloads Docker 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.4 - 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

Contributing

Thank you for wanting to improve shiba2sashimi! If you have any bugs or questions, feel free to open an issue or pull request.

Citation

If you use shiba2sashimi in your research, please cite the original Shiba paper:

Kubota N, Chen L, Zheng S. Shiba: a versatile computational method for systematic identification of differential RNA splicing across platforms. Nucleic Acids Research 53(4), 2025, gkaf098.

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.4.tar.gz (13.4 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.4-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shiba2sashimi-0.1.4.tar.gz
  • Upload date:
  • Size: 13.4 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.4.tar.gz
Algorithm Hash digest
SHA256 6491f6a1d464b0de57cd62b554a211ff26f563fb9de6c978df5c212153c5bda0
MD5 f012dae65424ab638436c7661a01acc9
BLAKE2b-256 284358b9596b26a2a8556dc065f5bf94737315f29f3d2e3eda0b0aba4b9514e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shiba2sashimi-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 14.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 47d5b6340a0f470fa5942fedee612f655fb130a0c1666716d0e1c351ad041748
MD5 386d618cc5665d2fd4650caaf2835ca7
BLAKE2b-256 2265f515caeb9c306e7cb77d496abe8e986c4ffc5dfe1016c7a37f3775176f7c

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