efp-seq_browser

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.

https://github.com/bioanalyticresource/efp-seq_browser

Science Score: 75.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • Institutional organization owner
    Organization bioanalyticresource has institutional domain (bar.utoronto.ca)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary

Keywords

alternative-splicing arabidopsis arabidopsis-thaliana bam bioinformatics data-visualization database efp rna-seq rna-seq-mapping webapp
Last synced: 6 months ago · JSON representation ·

Repository

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.

Basic Info
Statistics
  • Stars: 13
  • Watchers: 2
  • Forks: 7
  • Open Issues: 3
  • Releases: 14
Topics
alternative-splicing arabidopsis arabidopsis-thaliana bam bioinformatics data-visualization database efp rna-seq rna-seq-mapping webapp
Created over 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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.

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

Clone the repository with git by running the following command:

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

You will need Node.js and Python3 installed on your system to run the eFP-Seq Browser locally.

To set-up and install the prerequisites, run the following commands:

bash npm run install:all

which will install all the necessary Node and Python dependencies for the eFP-Seq Browser.

Running locally

To run the eFP-Seq Browser locally, once all packages are installed, simply run the following command and open your browser to http://localhost:3030/:

bash npm run start

This command will spin up two servers, one for the front-end and one for the back-end. The front-end server will be running on port 3030 and the back-end server will be running on port 3040.

[!NOTE] If you are running the backend Python scripts, because we are using CGI, you may want to run this in a Linux environment or modify the following files to get them working on your system: get_gene_structures.cgi and rnaSeqMapCoverage.cgi

Troubleshooting

Python3 not found

If you are using python instead of python3 as your Python executable, you can modify the start:backend script in package.json to use python instead of python3.

Validation

To run and test the eFP-Seq Browser code, you can run the following command:

bash npm run validate

Which will run the following commands:

  • Prettier to format the code (npm run prettier)

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

Owner

  • Name: BioAnalyticResource
  • Login: BioAnalyticResource
  • Kind: organization
  • Location: University of Toronto

Data visualization tools for multiple levels of plant data.

Citation (CITATION.cff)

cff-version: 1.2.0
title: eFP-Seq Browser
message: >-
    An 'eFP-Seq Browser' for visualizing and exploring RNA
    sequencing data
type: software
authors:
    - given-names: Alexander
      family-names: Sullivan
      email: alexjsully.connect@outlook.com
      orcid: "https://orcid.org/0000-0002-4463-4473"
    - given-names: Priyank K.
      family-names: Purohit
    - given-names: Nowlan H.
      family-names: Freese
    - given-names: Asher
      family-names: Pasha
      orcid: "https://orcid.org/0000-0002-9315-0520"
    - given-names: Eddi
      family-names: Esteban
      orcid: "https://orcid.org/0000-0001-9016-9202"
    - given-names: Jamie
      family-names: Waese
    - given-names: Alison
      family-names: Wu
    - given-names: Michelle
      family-names: Chen
    - given-names: Chih Y.
      family-names: Chin
    - given-names: Richard
      family-names: Song
    - given-names: Sneha R.
      family-names: Watharkar
    - given-names: Agnes P.
      family-names: Chan
    - given-names: Vivek
      family-names: Krishnakumar
    - given-names: Matthew W.
      family-names: Vaughn
    - given-names: Chris
      family-names: Town
    - given-names: Ann E.
      family-names: Loraine
      affiliation: University of North Carolina
      email: ann.loraine@uncc.edu
    - given-names: Nicholas J.
      family-names: Provart
      orcid: "https://orcid.org/0000-0001-5551-7232"
      email: nicholas.provart@utoronto.ca
      affiliation: University of Toronto
identifiers:
    - type: doi
      value: 10.1111/tpj.14468
repository-code: "https://github.com/BioAnalyticResource/eFP-Seq_Browser"
url: "https://bar.utoronto.ca/eFP-Seq_Browser/"
abstract: >-
    Improvements in next-generation sequencing technologies
    have resulted in dramatically reduced sequencing costs.
    This has led to an explosion of '-seq'-based methods, of
    which RNA sequencing (RNA-seq) for generating
    transcriptomic data is the most popular. By analysing
    global patterns of gene expression in organs/tissues/cells
    of interest or in response to chemical or environmental
    perturbations, researchers can better understand an
    organism's biology. Tools designed to work with large
    RNA-seq data sets enable analyses and visualizations to
    help generate hypotheses about a gene's function. We
    present here a user-friendly RNA-seq data exploration
    tool, called the 'eFP-Seq Browser', that shows the read
    map coverage of a gene of interest in each of the samples
    along with 'electronic fluorescent pictographic' (eFP)
    images that serve as visual representations of expression
    levels. The tool also summarizes the details of each
    RNA-seq experiment, providing links to archival databases
    and publications. It automatically computes the reads per
    kilobase per million reads mapped expression-level
    summaries and point biserial correlation scores to sort
    the samples based on a gene's expression level or by how
    dissimilar the read map profile is from a gene splice
    variant, to quickly identify samples with the strongest
    expression level or where alternative splicing might be
    occurring. Links to the Integrated Genome Browser desktop
    visualization tool allow researchers to visualize and
    explore the details of RNA-seq alignments summarized in
    eFP-Seq Browser as coverage graphs. We present four cases
    of use of the eFP-Seq Browser for ABI3, SR34, SR45a and
    U2AF65B, where we examine expression levels and identify
    alternative splicing. The URL for the browser is
    https://bar.utoronto.ca/eFP-Seq_Browser/.
keywords:
    - bioinformatics
    - computational biology
    - rna-seq
    - data visualization
    - arabidopsis thaliana
    - rna-seq mapping
    - alternative splicing
    - web application
license: GPL-2.0
commit: a5b952bf2df11e9c8538b372f2ee0d3c23d1fa90
version: 1.3.15
date-released: "2024-01-15"

GitHub Events

Total
  • Issues event: 3
  • Watch event: 1
  • Delete event: 9
  • Issue comment event: 8
  • Push event: 14
  • Pull request review event: 7
  • Pull request review comment event: 1
  • Pull request event: 18
  • Create event: 4
Last Year
  • Issues event: 3
  • Watch event: 1
  • Delete event: 9
  • Issue comment event: 8
  • Push event: 14
  • Pull request review event: 7
  • Pull request review comment event: 1
  • Pull request event: 18
  • Create event: 4

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 373
  • Total Committers: 4
  • Avg Commits per committer: 93.25
  • Development Distribution Score (DDS): 0.054
Past Year
  • Commits: 21
  • Committers: 2
  • Avg Commits per committer: 10.5
  • Development Distribution Score (DDS): 0.048
Top Committers
Name Email Commits
Alexander Sullivan a****n@h****m 353
Alexander Sullivan A****y 17
asherpasha a****a@u****a 2
aloraine a****e@g****m 1
Committer Domains (Top 20 + Academic)