-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Course with more content #31
Changes from all commits
26e8d6a
a774a3f
3d32d4d
b501bbc
5e21c96
a4af23c
ad96519
5c9518e
dfd1554
c2acf17
e6a6e7d
08b7aa7
57e07ea
cc8a53f
00e0bb0
923702f
b14640f
3f8f911
dadfc6e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,115 @@ | ||||||
|
||||||
# Prerequisites | ||||||
|
||||||
```{r, include = FALSE} | ||||||
ottrpal::set_knitr_image_path() | ||||||
``` | ||||||
|
||||||
## Learning Objectives | ||||||
|
||||||
This chapter will cover the prerequisites for this course, including: | ||||||
|
||||||
- Installing Docker | ||||||
- Installing R Studio | ||||||
- Downloading data files | ||||||
|
||||||
## Docker | ||||||
|
||||||
For the purpose of this course, we will be using Docker to run pVACseq and | ||||||
pVACfuse. | ||||||
Docker is a tool that is used to automate the deployment of applications | ||||||
in lightweight containers so that applications can work efficiently in | ||||||
different environments in isolation. We provide versioned Docker containers | ||||||
for all pVACtools [releases](https://github.com/griffithlab/pVACtools/releases) | ||||||
via [Docker Hub using the griffithlab/pvactools image name](https://hub.docker.com/r/griffithlab/pvactools). | ||||||
|
||||||
In order to use Docker, you will to download the [Docker Desktop software](https://www.docker.com/get-started/). | ||||||
Please ensure you select the correct install package for your operating | ||||||
system. | ||||||
|
||||||
## Terminal | ||||||
|
||||||
We will be running Docker from the command line on your preferred terminal | ||||||
using the Docker command line interface (CLI). The Docker CLI is already | ||||||
included with Docker Desktop. Most operating systems already | ||||||
come with a Terminal application. If yours doesn't, you will need to first | ||||||
install one. | ||||||
|
||||||
## R Studio and R package dependencies | ||||||
|
||||||
In order to use pVACview, you will need to download R. Please refer | ||||||
[here](https://cran.rstudio.com/) for downloading R (version 3.5 and above | ||||||
required). You may also take the additional step of [downloading R | ||||||
studio](https://www.rstudio.com/products/rstudio/download/) if | ||||||
you are not familiar with launching R Shiny from the command line. | ||||||
|
||||||
Additionally, there are a number of packages you will need to install in your R/R studio: | ||||||
|
||||||
```{r, eval = FALSE} | ||||||
install.packages("shiny", dependencies=TRUE) | ||||||
install.packages("ggplot2", dependencies=TRUE) | ||||||
install.packages("DT", dependencies=TRUE) | ||||||
install.packages("reshape2", dependencies=TRUE) | ||||||
install.packages("jsonlite", dependencies=TRUE) | ||||||
install.packages("tibble", dependencies=TRUE) | ||||||
install.packages("tidyr", dependencies=TRUE) | ||||||
install.packages("plyr", dependencies=TRUE) | ||||||
install.packages("dplyr", dependencies=TRUE) | ||||||
install.packages("shinydashboard", dependencies=TRUE) | ||||||
install.packages("shinydashboardPlus", dependencies=TRUE) | ||||||
install.packages("fresh", dependencies=TRUE) | ||||||
install.packages("shinycssloaders", dependencies=TRUE) | ||||||
install.packages("RCurl", dependencies=TRUE) | ||||||
install.packages("curl", dependencies=TRUE) | ||||||
install.packages("string", dependencies=TRUE) | ||||||
install.packages("shinycssloaders", dependencies=TRUE) | ||||||
``` | ||||||
|
||||||
## Data | ||||||
|
||||||
For this course, we have put together a set of input data generated from the breast | ||||||
cancer cell line HCC1395 and a matched normal lymphoblastoid cell line HCC1395BL. | ||||||
Data from this cell line is commonly used as test data in bioinformatics applications. | ||||||
For more information on these lines and the generation of test data, please refer to | ||||||
the data section of our precision medicine bioinformatics course: | ||||||
[here](https://pmbio.org/module-02-inputs/0002/05/01/Data/). | ||||||
Comment on lines
+74
to
+75
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This works fine. Could also consider making "the data section of our precision medicine bioinformatics course" the link! |
||||||
|
||||||
The input data consists of the following files: | ||||||
|
||||||
For pVACseq: | ||||||
|
||||||
- `annotated.expression.vcf.gz`: A somatic (tumor-normal) VCF and its tbi index file. The VCF has been | ||||||
annotated with VEP and has coverage and expression information added. It has also been annotated with | ||||||
custom VEP plugins that provide wild type and mutant version of the full length protein sequences | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
(Assuming "wild type" and "mutant" are both versions.) |
||||||
predicted to arise from each transcript annotated with each variant. | ||||||
- `phased.vcf.gz`: A phased tumor-germline VCF and its tbi index file to provide information about | ||||||
in-phase proximal variants that might alter the predicted peptide sequence around a somatic | ||||||
mutation of interest | ||||||
- `optitype_normal_result.tsv`: A OptiType file with HLA allele typing predictions | ||||||
|
||||||
For more detailed information on how the variant input file is created, please refer to the | ||||||
[input file preparation](https://pvactools.readthedocs.io/en/latest/pvacseq/input_file_prep.html) | ||||||
section of the pVACtools docs | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
For pVACfuse: | ||||||
|
||||||
- `agfusion_results`: A AGFusion output directory with annotated fusion calls | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- `star-fusion.fusion_predictions.tsv`: A STARFusion prediction file with fusion read support | ||||||
and expression information | ||||||
|
||||||
General: | ||||||
|
||||||
- `Homo_sapiens.GRCh38.pep.all.fa.gz`: A reference proteome peptide FASTA to use | ||||||
for determining whether there are any reference matches of neoantigen candidates | ||||||
|
||||||
To download this data, please run the following commands: | ||||||
|
||||||
```{r, engine = 'bash', eval = FALSE} | ||||||
wget https://raw.githubusercontent.com/griffithlab/pVACtools_Intro_Course/main/HCC1395_inputs.zip | ||||||
unzip HCC1395_inputs.zip | ||||||
``` | ||||||
|
||||||
This course will not cover the required pre-processing steps for the pVACtools | ||||||
input data but extensive instructions on how to prepare your own data for use | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
with pVACtools can be found at [pvactools.org](http://www.pvactools.org). | ||||||
|
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(or if you really like commas, could do
challenge, which involves
🙂 )