This Notebook / Voila webbrowser App comes with some demo data to highlight the features of the App and is available here . If you want to use this App for the analysis of your own (patient) RNA-Seq data, you need to first process this data. Instructions on how to process data in such a way that they can be used in the App can be found here.
Below, we describe how to install our Jupyter Notebook / Voila App for analysis and filtering of RNA-Seq data for clinical genetics diagnostics locally on your laptop / PC or (institute / department) server. First you need to choose a location where to download the data. In this example we will use /home/notebook/ as the destination to download and extract the zip file:
cd /home/notebook/
wget https://github.com/KlinGenErasmusMC/rnaseq-voila/archive/refs/heads/main.zip
unzip main.zip
All data from this repository should now be available at /home/notebook/rnaseq-voila-main/.
To run the Jupyter Notebook / Voila App, you need a working python and Jupyter / Voila installation with the following Python modules :
- dominate=2.3.1
- jupyter_core=4.11.1
- jupyterlab=3.4.8
- jupyter_server=1.21.0
- python=3.7.12
- plotly=5.1.0
- nbconvert=6.5.3
- matplotlib-base
- pandas
- ipywidgets
- scikit-learn
- wheel=0.37.1
- voila=0.3.6
The requirements.txt file should lists all required Python libraries that the notebook depend on, and they can be installed using:
pip install -r requirements.txt
If you prefer, you can use the environment.yml file to install the whole environment using Anaconda / Miniconda :
conda env create --file environment.yml
When the conda environment has been successfully created, it can be activated with the following command
conda activate rnaseq-voila
and used to run the Notebook server and/or Voila app as detailed below.
To start the Notebook server, first find out the IP of the machine that will host the server (here 101.66.22.62) and choose an available port. To more easily navigate to the notebook / app, you can start the Notebook server from the folder where you downloaded the data to (here /home/notebook/rna-voila-main/ ).
jupyter-notebook --NotebookApp.ip=101.66.22.62 --no-browser --port=8888 --notebook-dir=/home/notebook/rnaseq-voila-main/
You can then interact with the Python code in the notebook at this URL. Please note that you will need to change this URL to suit your local server configuration.
Working in the Notebook gives you the freedom to do (additional) data analysis on the data yourself. A more user-friendly Voila web-app version can be started by clicking on the Voila logo :
Or alternatively, in case you do not wish to change / interact with the code, you can instead of running the Notebook server, start the Voila app directly :
voila --port=8866 --ExecutePreprocessor.timeout=360 --no-browser --Voila.ip=101.66.22.62 /home/notebook/rna-voila-main/rnaseq-filtering-app.ipynb
You can then connect to the App at this URL. A user manual explaining the functionality of the App can be found here.
Jordy Dekker, Rachel Schot, Michiel Bongaerts, Walter G. de Valk, Monique van Veghel-Plandsoen, ..., Grazia M.S. Mancini, Tjakko J. van Ham. RNA-sequencing improves diagnosis for neurodevelopmental disorders by identifying pathogenic non-coding variants and reinterpretation of coding variants. medRxiv; doi: https://doi.org/10.1101/2022.06.05.22275956