Skip to content

Automated generation of tailored bioinformatics Jupyter Notebooks via a user interface.

License

Notifications You must be signed in to change notification settings

BulutHamali/biojupies_Hamali

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BioJupies

Notebooks Generated Datasets Available Plugins

Automated generation of Jupyter Notebooks for RNA-seq data analysis via user interface (http://biojupies.cloud).

Source code for the RNA-seq analysis plugins available at https://github.com/MaayanLab/biojupies-plugins.

Overview

  1. What is BioJupies?
  2. How can I generate notebooks using BioJupies?
  3. How can I upload my own RNA-seq data to BioJupies?
  4. What analyses can BioJupies perform?
  5. Can I contribute my RNA-seq analysis tools?
  6. How can I download and rerun my notebooks?
  7. References

What is BioJupies?

BioJupies is a web server which allows users to automatically generate Jupyter Notebooks from RNA-seq datasets through an intuitive interface, with no knowledge of coding required. It can be accessed for free from http://biojupies.cloud. Screenshot of the BioJupies website landing page.

How can I generate a notebook using BioJupies?

Generating a notebook using BioJupies requires three steps:

Screenshot of the BioJupies website landing page.

  1. First, select an RNA-seq dataset you with to analyze. You can upload FASTQ files, gene expression tables, or use a search engine to browse over 6,000 public datasets published in the Gene Expression Omnibus and processed by ARCHS4.
  2. Second, add one or more computational tools to analyze the data. BioJupies currently supports 14 plugins to perform exploratory data analysis, differential gene expression, enrichment analysis, and small molecule queries.
  3. Third, generate the notebook with the desired settings. The notebook will be served to you through a URL, and can be easily downloaded and rerun on your local computer.

How can I upload my RNA-seq data to BioJupies?

Users can upload their RNA-seq datasets for analysis at https://amp.pharm.mssm.edu/biojupies/upload.

Screenshot of the BioJupies upload page.

BioJupies currently supports uploading RNA-seq datasets in the FASTQ format or tables of gene-level counts.

Note: While the user may successfully generate a notebook from normalized gene expression counts or microarray data tables, the tools are NOT yet optimized to handle such data. Such results should be interpreted with caution.

The Enrichment Analysis and Small Molecule Query plugins currently support datasets uploaded with gene symbols as row identifiers. When uploading datasets with different identifiers (e.g. ENSEMBL IDs, Entrez IDs), please note that these plugins may return empty results.


What analyses can BioJupies perform?

BioJupies currently provides 14 RNA-seq data analysis plugins, divided into four categories. For more information about the plugins, visit https://github.com/MaayanLab/biojupies-plugins.

Screenshot of the BioJupies upload page.

Can I contribute my RNA-seq analysis tools?

Developers are welcome to contribute their own RNA-seq data analysis plugins for integration in BioJupies. Once integrated, the plugin will be made available to all users for notebook generation and published on the BioJupies plugins GitHub repository.

To contribute your plug-in, please visit https://amp.pharm.mssm.edu/biojupies/contribute.


How can I download and rerun my notebooks?

After generating a notebook, users can download and execute it locally using the maayanlab/biojupies-notebooks Docker container.

To do this, the following steps are required:

  1. Pull the latest version of the Docker container from the console:
docker pull maayanlab/biojupies-notebooks
  1. Identify the notebook's unique ID (a 9-character alphanumeric string) from its URL - e.g. 5DAHiejHN.

Screenshot of the a BioJupies notebook UID.

  1. Launch the Docker container.
docker run -it -p 8888:8888 -e NOTEBOOK_UID=5DAHiejHN maayanlab/biojupies-notebooks

Note: replace 5DAHiejHN with the UID of the notebook you wish to rerun.

  1. Access the local Jupyter Notebook server from your browser at port 8888.

Screenshot of the a local Jupyter Server.

  1. Execute and customize your notebook from the Jupyter server.

Screenshot of the a local Jupyter Server.

For more information about reusing notebooks, see https://amp.pharm.mssm.edu/biojupies/docker.


References

BioJupies is available as a pre-print on BioRxiv: BioJupies: Automated Generation of Interactive Notebooks for RNA-seq Data Analysis in the Cloud Torre, D., Lachmann, A., and Ma’ayan, A. (Cell Systems, 2018)

License

This project is licensed under the Apache-2.0 License - see the LICENSE.md file for details

About

Automated generation of tailored bioinformatics Jupyter Notebooks via a user interface.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 62.9%
  • Python 24.3%
  • JavaScript 5.7%
  • CSS 5.3%
  • Shell 1.3%
  • Dockerfile 0.4%
  • R 0.1%