This jupyter notebook is written for use with an R kernel.
The notebook details steps from locating publically-available RNAseq counts, abundance, and clinical data from TCGA through identification of differentially expressed genes with DESeq2 and the visualization of th results.
Content is provided in the form of Jupyter notebooks. If you need an introduction to Jupyter, you can see the official documents.
You can run these notebooks on a jupyterhub server - potentially one provided by your course - or on your own computer, appropriately configured Python, R, an RKernel, and appropriate R libraries (installed through the first notebook).
For new users, I highly recommend installing Jupyter through Anaconda following these instructions and installing the latest version of Python 3.x. note by default Windows does not add Anaconda or Jupyter to your PATH. You can change this during the installation by telling it to install to the PATH see step 6 of these Jupyter installation instructions here. If you do not add anaconda to your PATH you will need to open it using the app or change the PATH later.
For this particular assignment, you will also need R. You can download and find installation instructions here.
After R is installed, it needs to be configured for Jupyter to establish an RKernel. You can do this by installing an RKernel. Follow the instructions on the page and be sure to launch R from the command line instead of the app icon. Installation of the RKernel will fail if you launch from the app icon on Windows. note if anaconda is not in your path, R will not find it when trying to push RKernel. If you open the Anaconda prompt and run R from there, it should find Jupyter.
note For R projects, I highly recommend using RStudio and RMarkdown instead of Jupyter Notebooks, but that will not be required to complete this module, which was written in Jupyter for purpose of instruction.
2. Create a github or gitlab account (these instructions are copied from this readme.
Github and GitLab are two popular community sites based on the Git source-code control system. We're going to use Git to create your own local copy of these modules, and to store any changes. We'll tell you a bit about it here, but there's much more to learn - for more information on Git, see git-scm.com.
For now, go to either Github or GitLab and create an account. Remember your account name.
The Jupyter notebook exercises for this module are contained in a GitHub repository - a collection of related files managed using the Git source code control system. To do your work for these modules, you will need your own personal copy of this repository stored in your GitHub or GitLab account. Below, we give different descriptions for GitHub and GitLab.
To do this in GitHub will require three browser windows:
- The first should be pointed at the GitHub.com repository that this file is in. You're probably on that page right now as you read this file.
- The second window should be on your Jupyter notebook or JupyterLab home page.
Once this is setup, we can go to work.
- In the window on your GitHub repository page, press the "fork" button, found just below your avatar and user name in the title bar. It will ask you "Where should we fork this repository?". Choose the selection corresponding to your GitHub user name. The system will ask you to wait, and it will point you to a new page with a copy of this repository under your account. This is now your repository to use as you will, without any fear of damaging the main repository.
- On this page, there is a "Clone or download" button. Click on this button and copy the link that shows up. You will need this URL in step 5.
- Go to your GitLab homepage.
- Click "+" in the top menu bar.
- Select "New Project"
- Click "Import Project" and then "Git Repo by URL"
- At the top of the page containing this document, click on "Clone or download". Copy this URL
- Paste this URL into the "Git repository URL" textbook on the GitLab import page.
- Click "create project". You can keep the repository to start.
- You'll see a message indicating that something is happening.
- When it is done, go to your home page. You should see a new repository. Go to the home page of that repository. There will be a box under the repository title that says "SSH" with a URL next to it. Click on the "SSH" button to change it to "HTTPS".
- Copy the URL next to the "HTTPS" button. You will need this URL in step 5.
At this point, you should have the URL for your own personal copy of this repository. You will now need to clone it into your Jupyter environment.
- Go to your Jupyter home page (the easiest way to do this is to use the command
jupyter notebookfrom the command prompt). Click "New" on the top right, and select "Terminal". This will create a linux command-line terminal window in the browser. Alternatively, if you are using JupyterHub, press the "Terminal" button in the Launcher screen. - run
git clone ...replacing the ... with the URL of your repository. You will need to provide your GitHub or GitLab user name and password. Note if you receive an error, it might be because you do not have git installed. To install git follow the instructions here. - In a new browser tab (or in an existing browser tab if you already have it open), go to the home page of your Jupyter environment. You will see a new directory, likely entitled "tcga_brca_rnaseq". This is where you will do your work. If you are using JupyterLab, this directory will appear in the file browser on the left.
If everything is appropriately installed and cloned you should be able to run the notebooks.
Finish reading the rest of this readme and then when ready click on the notebooks to open them and start. Be sure to choose the RKernel.
This assignment is broken into 4 different python notebooks. Do them in order. Notebooks 2-4 have optional steps at the beginning of each in case you do not continue directly from the previous notebook. The 4 notebooks are:
1. RNASeq_TCGA_Introduction_Download - In the first notebook, we will:
- a) learn about RNA sequencing technology, analysis pipelines, sources of data, and about a specific question we will answer through these notebooks. The question is what are the differentially expressed genes between the HER2+ and TNBC subtypes of breast cancer.
- b) install all of the necessary R packages to complete this assignment. If installations fail for any of the packages, please follow the documentation at their respective websites to correct. Contact your instructor if issues remain.
- c) Download and decompress all the data.
2. Data wrangling - Prepping raw clinical and transcript counts data to generate gene level data for DEseq2 using tximport - In this lesson, you will do all of the data wrangling necessary to run DESeq2 to answer our question. This includes:
- a) Extract and calculate HER2 and TNBC status of each sample.
- b) Extract count and abundance data from those samples.
- c) The count and abundance data is transformed and currently at the transcript level, so we will need to untransform and collapse to gene level to perform the differential expressional analysis. In this notebook we will prep the data into the proper form to collapse into gene level.
3. Running Tximport and DESeq2 - In this lesson, you will perform the differential gene expression analysis. This includes:
- a) Run Tximport, which will collapse count and abundance data to the gene level.
- b) Calculate differentially expressed genes using DESeq2.
4. Visualize and Annotate DESeq2 results - In this lesson, you will annotate, export, and visualize the results. This includes:
- a) Annotate the results table to include GeneSymbol and information about abundance
- b) Visualize the results with a few QC plots
- c) Generate a heatmap of filtered DEGs