Skip to content

An RNA-Seq data exploration tool that shows read map coverage of a gene of interest along with a coloured "electronic fluorescent pictographic" (eFP) based on its RPKM expression level.

License

Notifications You must be signed in to change notification settings

BioAnalyticResource/eFP-Seq_Browser

eFP-Seq-Browser

The eFP-Seq Browser is an RNA-Seq data exploration tool that shows read map coverage of a gene of interest along with an "electronic fluorescent pictographic" (eFP) image. This web-tool also allows the generation of new datasets if provided with SAM/BAM (with their index files) to allow visualization of any RNA-Seq mapping coverage. Gene expression levels and the similarity is also shown by calculating the Reads per Kilobase per Million reads mapped (RPKM) expression levels and Point Biserial Correlation Coefficient (rpb) scores amongst its different splice variants.

Official publication of the eFP-Seq Browser can be found at https://doi.org/10.1111/tpj.14468.

Maintainability Follow on Twitter GitHub repo size GitHub Website

Getting Started

It is recommended that you use the web version available at https://bar.utoronto.ca/eFP-Seq_Browser/ but if you want to download and run the eFP-Seq Browser locally, it is possible though it may require an internet connection to reach our webservices and Araport's APIs.

Browser Compatibilities

Chrome Firefox Edge Safari Opera Tor Mobile

Installation/Open

Clone the repository with git by running the following command:

git clone https://github.com/BioAnalyticResource/eFP-Seq-Browser.git

If you wish to modify the code, all .CGI files use Python 3 as well as there are a few Perl scripts. The primary webservice (rnaSeqMapCoverage.cgi) requires SAMTools and bcftools.

There are also some JavaScript packages that are optional to install. These packages are used for code quality and creating the service workers for the web application. To install these, ensure you have Node version 16.18.0 or higher installed and run the following commands:

npm install

Outside of that, there is nothing to install, just download all the files and have your server host the index.html file and change all the Python scripts from our server to yours.

Known issues

We aim to make the eFP-Seq Browser as perfect as possible but unfortunately, there may be some unforeseen bugs. If you manage to find one that is not here, feel free to create a bug report so we can fix it.

Current known issues:

  • The IGB links do not work with Google Drive repositories
  • If the web service timeouts, the eFP-Seq Browser will load continuously

Contributing

Please read CONTRIBUTING.md for more details.

License

SVG images are CC-BY SA 4.0. For rest: GPL-2.0

Authors