---
title: "Using `RTCGA` package to download RPPA data that are included in `RTCGA.RPPA` package"
subtitle: "Date of datasets release: 2015-11-01"
author: "Witold Chodor"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Using RTCGA to download RPPA data as included in RTCGA.RPPA}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, echo=FALSE}
library(knitr)
opts_chunk$set(comment="", message=FALSE, warning = FALSE, tidy.opts=list(keep.blank.line=TRUE, width.cutoff=150), options(width=150), eval = FALSE)
```

# RTCGA package

> The Cancer Genome Atlas (TCGA) Data Portal provides a platform for researchers to search, download, and analyze data sets generated by TCGA. It contains clinical information, genomic characterization data, and high level sequence analysis of the tumor genomes. The key is to understand genomics to improve cancer care.

`RTCGA` package offers download and integration of the variety and volume of TCGA data using patient barcode key, what enables easier data possession. This may have a benefcial infuence on  development of science and improvement of patients' treatment. `RTCGA` is an open-source R package, available to download from Bioconductor 

```{r, eval=FALSE}
if (!requireNamespace("BiocManager", quietly=TRUE))
    install.packages("BiocManager")
BiocManager::install("RTCGA")
```

or use below code to download the development version which is like to be more bug-free than the release version on Bioconductor:

```{r, eval=FALSE}
if (!require(devtools)) {
    install.packages("devtools")
    require(devtools)
}
install_github("RTCGA/RTCGA")
```

Furthermore, `RTCGA` package transforms TCGA data into form which is convenient to use in R statistical package. Those data transformations can be a part of statistical analysis pipeline which can be more reproducible with `RTCGA`.

Use cases and examples are shown in `RTCGA` packages vignettes:
```{r, eval=FALSE}
browseVignettes("RTCGA")
```

# How to download RPPA data to gain the same datasets as in RTCGA.RPPA package?

There are many available date times of TCGA data releases. To see them all just type:
```{r, eval=FALSE}
library(RTCGA)
checkTCGA('Dates')
```

Version 1.0 of `RTCGA.RPPA` package contains RPPA datasets which were released `2015-11-01`. They were downloaded in the following way (which is mainly copied from [http://rtcga.github.io/RTCGA/](http://rtcga.github.io/RTCGA/):

## Available cohorts

All cohort names can be checked using:
```{r, eval=FALSE}
(cohorts <- infoTCGA() %>% 
   rownames() %>% 
   sub("-counts", "", x=.))
```

For all cohorts the following code downloads the RPPA data.

## Downloading RPPA files
```{r, eval=FALSE}
# dir.create( "data2" ) # name of a directory in which data will be stored
releaseDate <- "2015-11-01"
sapply( cohorts, function(element){
tryCatch({
downloadTCGA( cancerTypes = element, 
              dataSet = "protein_normalization__data.Level_3",
              destDir = "data2", 
              date = releaseDate )},
error = function(cond){
   cat("Error: Maybe there weren't mutations data for ", element, " cancer.\n")
}
)
})
```

## Reading downloaded RPPA dataset

### Shortening paths and directories 

```{r, eval=FALSE}
list.files( "data2") %>% 
   file.path( "data2", .) %>%
   file.rename( to = substr(.,start=1,stop=50))
```


### Removing `NA` files from data2 folder

If there were not RPPA data for some cohorts we should remove corresponding `NA` files.

```{r, eval=FALSE}
list.files( "data2") %>%
   file.path( "data2", .) %>%
   sapply(function(x){
      if (x == "data2/NA")
         file.remove(x)      
   })
```

### Paths to RPPA data

Below is the code that removes unneeded "MANIFEST.txt" file from each RPPA cohort folder.

```{r}
list.files( "data2") %>% 
   file.path( "data2", .) %>%
   sapply(function(x){
      file.path(x, list.files(x)) %>%
         grep(pattern = "MANIFEST.txt", x = ., value=TRUE) %>%
         file.remove()
      })
```


Below is the code that automatically assigns paths to files for all RPPA files for all available cohorts types downloaded to `data2` folder.

```{r}
list.files("data2") %>%
   file.path("data2", .) %>%
   sapply(function(y){
      file.path(y, list.files(y)) %>%
      assign( value = .,
              x = paste0(list.files(y) %>%
                                       gsub(x = .,
                                            pattern = "\\..*",
                                            replacement = "") %>%
                            gsub(x=., pattern="-", replacement = "_"),
                         ".RPPA.path"),
              envir = .GlobalEnv)
   })
```

### Reading RPPA data using `readTCGA`

Because of the fact that RPPA data are transposed in downloaded files, there has been prepared special function `readTCGA` to read and transpose data automatically. Code is below

```{r, eval=FALSE}
ls() %>%
   grep("RPPA\\.path", x = ., value = TRUE) %>%
   sapply(function(element){
      tryCatch({
         readTCGA(get(element, envir = .GlobalEnv),
               dataType = "RPPA") %>%
         assign(value = .,
                x = sub("\\.path", "", x = element),
                envir = .GlobalEnv )
      }, error = function(cond){
         cat(element)
      }) 
     invisible(NULL)
    }    
)
```

# Saving RPPA data to `RTCGA.RPPA` package


```{r, eval=FALSE}
grep( "RPPA", ls(), value = TRUE) %>%
   grep("path", x=., value = TRUE, invert = TRUE) %>%
   cat( sep="," ) #can one to it better? as from use_data documentation:
   # ...	Unquoted names of existing objects to save
   devtools::use_data(ACC.RPPA,BLCA.RPPA,BRCA.RPPA,CESC.RPPA,
                      CHOL.RPPA,COAD.RPPA,COADREAD.RPPA,DLBC.RPPA,
                      ESCA.RPPA,GBM.RPPA,GBMLGG.RPPA,HNSC.RPPA,
                      KICH.RPPA,KIPAN.RPPA,KIRC.RPPA,KIRP.RPPA,
                      LGG.RPPA,LIHC.RPPA,LUAD.RPPA,LUSC.RPPA,
                      MESO.RPPA,OV.RPPA,PAAD.RPPA,PCPG.RPPA,
                      PRAD.RPPA,READ.RPPA,SARC.RPPA,SKCM.RPPA,
                      STAD.RPPA,STES.RPPA,TGCT.RPPA,THCA.RPPA,
                      THYM.RPPA,UCEC.RPPA,UCS.RPPA,UVM.RPPA,
                      overwrite = TRUE,
                      compress="xz")
```
