TCGAbiolinks has provided a few functions to search, download and parse clinical data. This section starts by explaining the different sources for clinical information in GDC, followed by the necessary function to access these sources.
In GDC database the clinical data can be retrieved from different sources:
There are two main differences between the indexed clinical and XML files:
Other useful clinical information available are:
In this example we will fetch clinical data from BCR Biotab files.
query <- GDCquery(
project = "TCGA-ACC",
data.category = "Clinical",
data.type = "Clinical Supplement",
data.format = "BCR Biotab"
)
GDCdownload(query)
clinical.BCRtab.all <- GDCprepare(query)
names(clinical.BCRtab.all)
query <- GDCquery(
project = "TCGA-ACC",
data.category = "Clinical",
data.type = "Clinical Supplement",
data.format = "BCR Biotab",
file.type = "radiation"
)
GDCdownload(query)
clinical.BCRtab.radiation <- GDCprepare(query)
clinical.BCRtab.all$clinical_drug_acc %>%
head %>%
DT::datatable(options = list(scrollX = TRUE, keys = TRUE))
In this example we will fetch all BRCA BCR Biotab files, and look for the ER status.
library(TCGAbiolinks)
query <- GDCquery(project = "TCGA-BRCA",
data.category = "Clinical",
data.type = "Clinical Supplement",
data.format = "BCR Biotab")
GDCdownload(query)
clinical.BCRtab.all <- GDCprepare(query)
## [1] "clinical_omf_v4.0_brca" "clinical_drug_brca"
## [3] "clinical_nte_brca" "clinical_patient_brca"
## [5] "clinical_radiation_brca" "clinical_follow_up_v2.1_brca"
## [7] "clinical_follow_up_v1.5_brca" "clinical_follow_up_v4.0_nte_brca"
## [9] "clinical_follow_up_v4.0_brca"
# colnames from clinical_patient_brca
tibble::tibble(sort(colnames(clinical.BCRtab.all$clinical_patient_brca)))
# Biospecimen BCR Biotab
query.biospecimen <- GDCquery(project = "TCGA-BRCA",
data.category = "Biospecimen",
data.type = "Biospecimen Supplement",
data.format = "BCR Biotab")
GDCdownload(query.biospecimen)
biospecimen.BCRtab.all <- GDCprepare(query.biospecimen)
## [1] "biospecimen_shipment_portion_brca" "biospecimen_sample_brca"
## [3] "biospecimen_portion_brca" "biospecimen_protocol_brca"
## [5] "ssf_normal_controls_brca" "biospecimen_diagnostic_slides_brca"
## [7] "biospecimen_aliquot_brca" "biospecimen_slide_brca"
## [9] "biospecimen_analyte_brca" "ssf_tumor_samples_brca"
In this example we will fetch clinical indexed data (same as showed in the data portal).
clinical %>%
head %>%
DT::datatable(filter = 'top',
options = list(scrollX = TRUE, keys = TRUE, pageLength = 5),
rownames = FALSE)
clinical %>%
head %>%
DT::datatable(filter = 'top',
options = list(scrollX = TRUE, keys = TRUE, pageLength = 5),
rownames = FALSE)
The process to get data directly from the XML are: 1. Use GDCquery
and GDCDownload
functions to search/download either biospecimen or clinical XML files 2. Use GDCprepare_clinic
function to parse the XML files.
The relation between one patient and other clinical information are 1:n, one patient could have several radiation treatments. For that reason, we only give the option to parse individual tables (only drug information, only radiation information,…) The selection of the table is done by the argument clinical.info
.
data.category | clinical.info |
---|---|
Clinical | drug |
Clinical | admin |
Clinical | follow_up |
Clinical | radiation |
Clinical | patient |
Clinical | stage_event |
Clinical | new_tumor_event |
Biospecimen | sample |
Biospecimen | bio_patient |
Biospecimen | analyte |
Biospecimen | aliquot |
Biospecimen | protocol |
Biospecimen | portion |
Biospecimen | slide |
Other | msi |
Below are several examples fetching clinical data directly from the clinical XML files.
query <- GDCquery(project = "TCGA-COAD",
data.category = "Clinical",
file.type = "xml",
barcode = c("TCGA-RU-A8FL","TCGA-AA-3972"))
GDCdownload(query)
clinical <- GDCprepare_clinic(query, clinical.info = "patient")
clinical %>%
datatable(filter = 'top',
options = list(scrollX = TRUE, keys = TRUE, pageLength = 5),
rownames = FALSE)
clinical.drug %>%
datatable(filter = 'top',
options = list(scrollX = TRUE, keys = TRUE, pageLength = 5),
rownames = FALSE)
MSI-Mono-Dinucleotide Assay is performed to test a panel of four mononucleotide repeat loci (polyadenine tracts BAT25, BAT26, BAT40, and transforming growth factor receptor type II) and three dinucleotide repeat loci (CA repeats in D2S123, D5S346, and D17S250). Two additional pentanucleotide loci (Penta D and Penta E) are included in this assay to evaluate sample identity. Multiplex fluorescent-labeled PCR and capillary electrophoresis were used to identify MSI if a variation in the number of microsatellite repeats was detected between tumor and matched non-neoplastic tissue or mononuclear blood cells. Equivocal or failed markers were re-evaluated by singleplex PCR.
classifications: microsatellite-stable (MSS), low level MSI (MSI-L) if less than 40% of markers were altered and high level MSI (MSI-H) if greater than 40% of markers were altered.
Reference: TCGA wiki
Level 3 data is included in BCR clinical-based submissions and can be downloaded as follows:
# Tissue slide image files from legacy database
query.legacy <- GDCquery(project = "TCGA-COAD",
data.category = "Clinical",
data.type = "Tissue slide image",
legacy = TRUE,
barcode = c("TCGA-RU-A8FL","TCGA-AA-3972"))
# Tissue slide image files from harmonized database
query.harmonized <- GDCquery(project = "TCGA-OV",
data.category = "Biospecimen",
data.type = 'Slide Image')
The clinical data types available in legacy database are:
# Clinical data
query <- GDCquery(project = "TCGA-COAD",
data.category = "Clinical",
data.type = "Clinical data",
legacy = TRUE,
file.type = "txt")
query %>%
getResults %>%
select(-matches("cases"))%>%
DT::datatable(options = list(scrollX = TRUE, keys = TRUE))
## [1] "clinical_radiation_coad" "clinical_nte_coad"
## [3] "clinical_patient_coad" "clinical_drug_coad"
## [5] "clinical_follow_up_v1.0_nte_coad" "clinical_omf_v4.0_coad"
## [7] "clinical_follow_up_v1.0_coad"
Also, some functions to work with clinical data are provided.
For example the function TCGAquery_SampleTypes
will filter barcodes based on a type the argument typesample.
Argument | Description | |
---|---|---|
barcode | is a list of samples as TCGA barcodes | |
typesample | a character vector indicating tissue type to query. Example: | |
TP | PRIMARY TUMOR | |
TR | RECURRENT TUMOR | |
TB | Primary Blood Derived Cancer-Peripheral Blood | |
TRBM | Recurrent Blood Derived Cancer-Bone Marrow | |
TAP | Additional-New Primary | |
TM | Metastatic | |
TAM | Additional Metastatic | |
THOC | Human Tumor Original Cells | |
TBM | Primary Blood Derived Cancer-Bone Marrow | |
NB | Blood Derived Normal | |
NT | Solid Tissue Normal | |
NBC | Buccal Cell Normal | |
NEBV | EBV Immortalized Normal | |
NBM | Bone Marrow Normal |
The function TCGAquery_MatchedCoupledSampleTypes
will filter the samples that have all the typesample provided as argument. For example, if TP and TR are set as typesample, the function will return the barcodes of a patient if it has both types. So, if it has a TP, but not a TR, no barcode will be returned. If it has a TP and a TR both barcodes are returned.
An example of the function is below:
bar <- c("TCGA-G9-6378-02A-11R-1789-07", "TCGA-CH-5767-04A-11R-1789-07",
"TCGA-G9-6332-60A-11R-1789-07", "TCGA-G9-6336-01A-11R-1789-07",
"TCGA-G9-6336-11A-11R-1789-07", "TCGA-G9-7336-11A-11R-1789-07",
"TCGA-G9-7336-04A-11R-1789-07", "TCGA-G9-7336-14A-11R-1789-07",
"TCGA-G9-7036-04A-11R-1789-07", "TCGA-G9-7036-02A-11R-1789-07",
"TCGA-G9-7036-11A-11R-1789-07", "TCGA-G9-7036-03A-11R-1789-07",
"TCGA-G9-7036-10A-11R-1789-07", "TCGA-BH-A1ES-10A-11R-1789-07",
"TCGA-BH-A1F0-10A-11R-1789-07", "TCGA-BH-A0BZ-02A-11R-1789-07",
"TCGA-B6-A0WY-04A-11R-1789-07", "TCGA-BH-A1FG-04A-11R-1789-08",
"TCGA-D8-A1JS-04A-11R-2089-08", "TCGA-AN-A0FN-11A-11R-8789-08",
"TCGA-AR-A2LQ-12A-11R-8799-08", "TCGA-AR-A2LH-03A-11R-1789-07",
"TCGA-BH-A1F8-04A-11R-5789-07", "TCGA-AR-A24T-04A-55R-1789-07",
"TCGA-AO-A0J5-05A-11R-1789-07", "TCGA-BH-A0B4-11A-12R-1789-07",
"TCGA-B6-A1KN-60A-13R-1789-07", "TCGA-AO-A0J5-01A-11R-1789-07",
"TCGA-AO-A0J5-01A-11R-1789-07", "TCGA-G9-6336-11A-11R-1789-07",
"TCGA-G9-6380-11A-11R-1789-07", "TCGA-G9-6380-01A-11R-1789-07",
"TCGA-G9-6340-01A-11R-1789-07", "TCGA-G9-6340-11A-11R-1789-07")
S <- TCGAquery_SampleTypes(bar,"TP")
S2 <- TCGAquery_SampleTypes(bar,"NB")
# Retrieve multiple tissue types NOT FROM THE SAME PATIENTS
SS <- TCGAquery_SampleTypes(bar,c("TP","NB"))
# Retrieve multiple tissue types FROM THE SAME PATIENTS
SSS <- TCGAquery_MatchedCoupledSampleTypes(bar,c("NT","TP"))
To get all the information for TGCA samples you can use the script below:
# This code will get all clinical indexed data from TCGA
library(data.table)
library(dplyr)
library(regexPipes)
clinical <- TCGAbiolinks:::getGDCprojects()$project_id %>%
regexPipes::grep("TCGA",value=T) %>%
sort %>%
plyr::alply(1,GDCquery_clinic, .progress = "text") %>%
rbindlist
readr::write_csv(clinical,path = paste0("all_clin_indexed.csv"))
# This code will get all clinical XML data from TCGA
getclinical <- function(proj){
message(proj)
while(1){
result = tryCatch({
query <- GDCquery(project = proj, data.category = "Clinical",file.type = "xml")
GDCdownload(query)
clinical <- GDCprepare_clinic(query, clinical.info = "patient")
for(i in c("admin","radiation","follow_up","drug","new_tumor_event")){
message(i)
aux <- GDCprepare_clinic(query, clinical.info = i)
if(is.null(aux) || nrow(aux) == 0) next
# add suffix manually if it already exists
replicated <- which(grep("bcr_patient_barcode",colnames(aux), value = T,invert = T) %in% colnames(clinical))
colnames(aux)[replicated] <- paste0(colnames(aux)[replicated],".",i)
if(!is.null(aux)) clinical <- merge(clinical,aux,by = "bcr_patient_barcode", all = TRUE)
}
readr::write_csv(clinical,path = paste0(proj,"_clinical_from_XML.csv")) # Save the clinical data into a csv file
return(clinical)
}, error = function(e) {
message(paste0("Error clinical: ", proj))
})
}
}
clinical <- TCGAbiolinks:::getGDCprojects()$project_id %>%
regexPipes::grep("TCGA",value=T) %>% sort %>%
plyr::alply(1,getclinical, .progress = "text") %>%
rbindlist(fill = TRUE) %>% setDF %>% subset(!duplicated(clinical))
readr::write_csv(clinical,path = "all_clin_XML.csv")
# result: https://drive.google.com/open?id=0B0-8N2fjttG-WWxSVE5MSGpva1U
# Obs: this table has multiple lines for each patient, as the patient might have several followups, drug treatments,
# new tumor events etc...