Skip to content

A command-line utility for the generation of comprehensive reports on ribosome profiling (Ribo-Seq) dataset quality

License

Notifications You must be signed in to change notification settings

JackCurragh/RiboMetric

Repository files navigation

RiboMetric

Documentation Status Updates

A python command-line utility for the generation of comprehensive reports on the quality of ribosome profiling (Ribo-Seq) datasets

Installation

To install RiboMetric:

$ pip install RiboMetric

Usage

Create annotation files from gff files:

$ RiboMetric preprare -g gff_file.gff

Use the annotation file to run RiboMetric on a bam file:

$ RiboMetric run -b bam_file.bam -a annotation_RiboMetric.tsv

For more information on how to use RiboMetric, see the documentation or use --help

Features

There are a number of limitations to running RiboMetric at the moment. These include:

  • Transciptomic alignments are required in BAM format
  • GFF annotations from Ensembl are also requried

Credits

This project was worked on by Lukas Wierdsma during his Internship at the UCC for Bioinformatics, Howest in 2023.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

About

A command-line utility for the generation of comprehensive reports on ribosome profiling (Ribo-Seq) dataset quality

Resources

License

Stars

Watchers

Forks

Packages

No packages published