1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
|
#' @title Retrieve summary of files per sample in a project
#' @description
#' Retrieve the numner of files under each
#' data_category + data_type + experimental_strategy + platform
#' Almost like https://portal.gdc.cancer.gov/exploration
#' @param project A GDC project
#' @param legacy Access legacy database ? Deafult: FALSE
#' @param files.access Filter by file access ("open" or "controlled").
#' Default: no filter
#' @export
#' @examples
#' summary <- getSampleFilesSummary("TCGA-UCS")
#' \dontrun{
#' summary <- getSampleFilesSummary(c("TCGA-OV","TCGA-ACC"))
#' }
#' @return A data frame with the maf file information
#' @importFrom tidyr spread unite
#' @importFrom plyr ldply count
#' @author Tiago Chedraoui Silva
getSampleFilesSummary <- function(project, legacy = FALSE, files.access = NA) {
out <- NULL
for(proj in project){
checkProjectInput(proj)
message("Accessing information for project: ", proj)
url <- getSampleSummaryUrl(proj,legacy)
x <- getURL(url,fromJSON,simplifyDataFrame = TRUE)
y <- x$data$hits$files
names(y) <- x$data$hits$submitter_id
df <- ldply(y, data.frame)
df <- df %>%
unite("type",
"data_category",
"data_type",
"experimental_strategy",
"platform",
na.rm = TRUE) %>%
plyr::count(c(".id","type")) %>%
tidyr::spread("type", "freq")
df$project <- proj
df[is.na(df)] <- 0
out <- rbind.fill(out,df)
}
return(out)
}
getSampleSummaryUrl <- function(project,legacy = FALSE, files.access = NA){
# Get manifest using the API
baseURL <- ifelse(legacy,"https://api.gdc.cancer.gov/legacy/cases/?","https://api.gdc.cancer.gov/cases/?")
options.pretty <- "pretty=true"
options.expand <- "expand=summary,summary.data_categories,files"
#option.size <- paste0("size=",getNbFiles(project,data.category,legacy))
option.size <- paste0("size=",1000)
option.format <- paste0("format=JSON")
options.filter <- paste0("filters=",
URLencode('{"op":"and","content":['), # Start json request
URLencode('{"op":"in","content":{"field":"cases.project.project_id","value":["'),
project,
URLencode('"]}}'))
if(!any(is.na(files.access))) {
options.filter <- paste0(options.filter,addFilter("files.access", files.access))
}
# Close json request
options.filter <- paste0(options.filter, URLencode(']}'))
url <- paste0(baseURL,paste(options.pretty,
options.expand,
option.size,
options.filter,
option.format,
sep = "&"))
return(url)
}
getSubmitterIDUrl <- function(project,legacy = FALSE, files.access = NA){
# Get manifest using the API
baseURL <- ifelse(legacy,"https://api.gdc.cancer.gov/legacy/cases/?","https://api.gdc.cancer.gov/cases/?")
options.pretty <- "pretty=true"
options.expand <- "expand=files.access"
#option.size <- paste0("size=",getNbFiles(project,data.category,legacy))
option.fields = "fields=submitter_id"
option.size <- paste0("size=",1000)
option.format <- paste0("format=JSON")
options.filter <- paste0("filters=",
URLencode('{"op":"and","content":['), # Start json request
URLencode('{"op":"in","content":{"field":"cases.project.project_id","value":["'),
project,
URLencode('"]}}'))
if(!any(is.na(files.access))) {
options.filter <- paste0(options.filter,addFilter("files.access", files.access))
}
# Close json request
options.filter <- paste0(options.filter, URLencode(']}'))
url <- paste0(baseURL,paste(options.pretty,
options.expand,
option.fields,
option.size,
options.filter,
option.format,
sep = "&"))
return(url)
}
# getSubmitterID("TCGA-BRCA")
# getSubmitterID("MMRF-COMPASS")
getSubmitterID <- function(project,legacy = FALSE, files.access = NA){
url <- getSubmitterIDUrl(project,legacy,files.access)
json <- tryCatch(
getURL(url,fromJSON,timeout(600),simplifyDataFrame = TRUE),
error = function(e) {
message(paste("Error: ", e, sep = " "))
message("We will retry to access GDC!")
fromJSON(content(getURL(url,GET,timeout(600)), as = "text", encoding = "UTF-8"), simplifyDataFrame = TRUE)
}
)
return(unique(json$data$hits$submitter_id))
}
# getBarcodefromAliquot(c("4e06e279-5f0d-4bf5-8659-67b8069050b8","bb6e1801-b08a-49b1-bc4b-205fdefb035b"))
#' @importFrom dplyr bind_rows
getBarcodefromAliquot <- function(aliquot){
baseURL <- "https://api.gdc.cancer.gov/cases/?"
options.fields <- "fields=samples.portions.analytes.aliquots.aliquot_id,samples.portions.analytes.aliquots.submitter_id"
options.pretty <- "pretty=true"
option.size <- paste0("size=",length(aliquot))
#message(paste(barcode,collapse = '","'))
#message(paste0('"',paste(barcode,collapse = '","')))
options.filter <- paste0("filters=",
URLencode('{"op":"and","content":[{"op":"in","content":{"field":"samples.portions.analytes.aliquots.aliquot_id","value":['),
paste0('"',paste(aliquot,collapse = '","')),
URLencode('"]}}]}'))
#message(paste0(baseURL,paste(options.pretty,options.expand, option.size, options.filter, sep = "&")))
url <- paste0(baseURL,paste(options.pretty,options.fields, option.size, options.filter, sep = "&"))
#message(url)
json <- tryCatch(
getURL(url,fromJSON,timeout(600),simplifyDataFrame = TRUE),
error = function(e) {
message(paste("Error: ", e, sep = " "))
message("We will retry to access GDC again! URL:")
#message(url)
fromJSON(content(getURL(url,GET,timeout(600)), as = "text", encoding = "UTF-8"), simplifyDataFrame = TRUE)
}
)
results <- json$data$hits
if(length(results) == 0){
message("aliquot_id not found")
return(NULL)
}
results <- plyr::ldply(results$samples,.fun = function(x){
plyr::ldply(x$portions,.fun = function(y){
plyr::ldply(y$analytes,.fun = function(z){
z$aliquots %>% bind_rows()
})
})
})
idx <- is.na(match(aliquot,results$aliquot_id))
if(any(idx)){
message("Some aliquot IDs were not found:",aliquot[idx])
}
results <- results[match(aliquot,results$aliquot_id),] %>% na.omit()
return(results)
}
#' internal function to break a huge API call into smaller ones
#' so it repects the max character limit of a string
#' @param items vector of items to be using within the function
#' (list of barcodes, aliquot ids, etc)
#' @param step How many items to be evaluated per API call
#' @param FUN function that calls the API
#' @author Tiago Chedraoui Silva
splitAPICall <- function(FUN, step = 20, items){
info <- NULL
info <- tryCatch({
for(i in 0:(ceiling(length(items)/step) - 1)){
start <- 1 + step * i
end <- ifelse(((i + 1) * step) > length(items), length(items),((i + 1) * step))
if(is.null(info)) {
info <- FUN(items[start:end])
} else {
info <- plyr::rbind.fill(info, FUN(items[start:end]))
}
}
info
}, error = function(e) {
step <- 2
for(i in 0:(ceiling(length(items)/step) - 1)){
start <- 1 + step * i
end <- ifelse(((i + 1) * step) > length(items), length(items),((i + 1) * step))
if(is.null(info)) {
info <- FUN(items[start:end])
} else {
info <- plyr::rbind.fill(info, FUN(items[start:end]))
}
}
})
info
}
#' Create a Summary table for each sample in a project saying if it contains
#' or not files for a certain data category
#' @description
#' Create a Summary table for each sample in a project saying if it contains
#' or not files for a certain data category
#' @param project A GDC project
#' @param legacy Access legacy (hg19) or harmonized database (hg38).
#' @return A data frame
#' @export
#' @importFrom stats xtabs
#' @examples
#' summary <- getDataCategorySummary("TCGA-ACC", legacy = TRUE)
#' @author Tiago Chedraoui Silva
getDataCategorySummary <- function(project, legacy = FALSE){
baseURL <- ifelse(legacy,"https://api.gdc.cancer.gov/legacy/files/?","https://api.gdc.cancer.gov/files/?")
url <- paste0(baseURL,"&expand=cases&size=100000&fields=cases.submitter_id,data_category&filters=",
URLencode('{"op":"and","content":[{"op":"in","content":{"field":"cases.project.project_id","value":["'),
URLencode(project),
URLencode('"]}}]}'))
json <- tryCatch(
getURL(url,fromJSON,timeout(600),simplifyDataFrame = TRUE),
error = function(e) {
fromJSON(content(getURL(url,GET,timeout(600)), as = "text", encoding = "UTF-8"), simplifyDataFrame = TRUE)
}
)
json <- json$data$hits
json$submitter_id <- unlist(lapply(json$cases, function(x) paste0(x$submitter_id,collapse = ",")))
json$cases <- NULL
json <- json[!duplicated(json),]
json <- json[stringr::str_length(json$submitter_id) == 12,]
ret <- as.data.frame.matrix(xtabs(~ submitter_id + data_category , json))
return(ret)
}
#' @title Get Project Summary from GDC
#' @param project A GDC project
#' @param legacy Select between Harmonized or Legacy database
#' @examples
#' getProjectSummary("TCGA-ACC")
#' \dontrun{
#' getProjectSummary("CPTAC-2")
#' }
#' @export
#' @author Tiago Chedraoui Silva
getProjectSummary <- function(project, legacy = FALSE){
checkProjectInput(project)
baseURL <- ifelse(legacy,"https://api.gdc.cancer.gov/legacy/projects/","https://api.gdc.cancer.gov/projects/")
url <- paste0(baseURL, project,"?expand=summary,summary.data_categories&pretty=true")
return(fromJSON(url,simplifyDataFrame = TRUE)$data$summary)
}
#' @title Get Number of cases in GDC for a project
#' @param project A GDC project
#' @param data.category A GDC project data category
#' @param legacy Select between Harmonized or Legacy database
#' @examples
#' \dontrun{
#' getNbCases("TCGA-ACC","Clinical")
#' getNbCases("CPTAC-2","Clinical")
#' }
#' @author Tiago Chedraoui Silva
getNbCases <- function(project, data.category, legacy = FALSE){
summary <- getProjectSummary(project, legacy)
if(data.category %in% summary$data_categories$data_category){
summary <- getProjectSummary(project, legacy)$data_categories
nb <- summary[summary$data_category == data.category,"case_count"]
} else {
nb <- summary$case_count
}
return(nb)
}
#' @title Get Number of files in GDC for a project
#' @param project A GDC project
#' @param data.category A GDC project data category
#' @param legacy Select between Harmonized or Legacy database
#' @examples
#' \dontrun{
#' getNbFiles("TCGA-ACC","Clinical")
#' getNbFiles("CPTAC-2","Clinical")
#' }
#' @author Tiago Chedraoui Silva
getNbFiles <- function(project, data.category, legacy = FALSE){
summary <- getProjectSummary(project, legacy)
if(data.category %in% summary$data_categories$data_category){
summary <- getProjectSummary(project, legacy)$data_categories
nb <- summary[summary$data_category == data.category,"file_count"]
} else {
nb <- summary$file_count
}
return(nb)
}
|