R/annoByGaps.R

In bioinfo16/VVIPS: Viral Vector Integration Position Seeker

#' @title Annotate the vector integrated site by gap information from assembly.
#' 
#' @description This function uses gap data to search the feature of integrated regions. 
#'              User can get query sequence inserted in annotated gaps and 
#'              distribution graphes from annotated gaps coordinations such as centromere and telomere.
#'              Plus, user can do random distribution analysis by this function.
#' 
#' @usage annoByGaps(hits, randomSet = NULL, mapTool = 'blast', organism = 'hg19', interval = 5000, range = c(-20000, 20000),
#'                   gapType = c('centromere', 'telomere'), outpath = '~', dbPath = paste0(.libPaths()[1], '/VVIPS/extdata'))
#' 
#' @param hits a GR object. This object made from *makeInputs* function.
#' @param randomSet TRUE or FALSE. For random distribution, function makes random set, if user enter TRUE.
#'                  If this value is FALSE, random distribution analysis is not executed. Default is TRUE.
#' @param mapTool a character. Function serve two types of file such as outputs from BLAST and BLAT.
#'                Default is 'blast'. If you want to use BLAT output, use 'blast'.
#' @param organism a single character. This function serves 3 versions of organisms such as hg19, hg38 (Human)
#'                 and galGal6 (Chicken). Default is 'hg19'.
#' @param interval an integer vector. This number means interval number for distribution analysis. Default is 5000.
#' @param randomSize an integer vector. A random set size. Default is 10000.
#' @param range an integer array. It means the range for highlight region of this analysis. Default range is c(-20000, 20000).
#' @param gapType a character vector. User can select annotated gap types such as centromere, telomere and heterochromatin. 
#' @param outpath a string vector. Plots are saved in this path. Default value is R home directory.
#' @param outFile a character vector. Attached ID to the result file name.
#' @param dbPath a string vector. Directory path of database files.
#' 
#' @return Return a result list constituted by insertion table, distribution table and GRobject of Gap data.
#'
#'
#' @export

annoByGaps = function(hits, randomSet = TRUE, mapTool = 'blast', organism = 'hg19', interval = 5000, randomSize = 10000,
                      range = c(-20000, 20000), gapType = c('centromere', 'telomere', 'heterochromatin'),
                      outpath = '~', outFile, dbPath = paste0(.libPaths()[1], '/VVIPS/extdata')){
  require(GenomicRanges); require(stringr); require(grDevices); require(ggplot2); require(writexl); require(plyr)
  
  cat('---------- Annotation integrated sites : Annotated gaps ----------\n')
  cat(paste0('Start time : ', date(), '\n'))
  
  if(length(which(c('hg19', 'hg38', 'galGal6') %in% organism)) == 0){
    return(cat("You can use hg19/hg38/galGal6 data only. ( Input : ", paste(organism, collapse = ','), ")\n",
               '---------- Annotation process is halted. ----------\nFinish time : ', date(), '\n'))
  } else {}
  
  if(str_ends(dbPath, pattern = '/')){
    dbPath = word(dbPath, start = 1, end = nchar(dbPath), sep = '')
  } else {}
  
  if(str_ends(outpath, pattern = '/')){
    outpath = word(outpath, start = 1, end = nchar(outpath), sep = '')
  } else {}
  
  cat('---------- Loading a gap annotation table ----------\n')
  #### 01. Load a gap table
  tab_gz = gzfile(description = paste0(dbPath, '/gap.txt.gz'), open = "r")
  suppressWarnings(dataTable <- read.delim(file = tab_gz, header = FALSE, stringsAsFactors = FALSE))
  dataTable = dataTable[,c(2,3,4,7,8)]
  colnames(dataTable) = c('chrom', 'start', 'end', 'size', 'type')
  close(tab_gz)
  
  dataTable = subset(dataTable, dataTable$type %in% gapType)
  dataTable[,2] = dataTable[,2]+1
  dataTable = dataTable[,c(1,2,3,5)]; names(dataTable) = c('chr', 'start', 'end', 'type')
  
  cat('Done.\n')
  
  if(randomSet){
    cat('---------- Make a random set ----------\n')
    #### 01. Generate random set
    set.seed(123456)
    
    ch_size = readRDS(file = system.file("extdata", paste0(organism, '_chrom.rds'), package = "VVIPS"))
    ch_size_num = as.numeric(ch_size$length)
    ch_start = cumsum(ch_size_num) - ch_size_num + 1
    ch_end = cumsum(ch_size_num)
    ch_ratio = (ch_size_num / sum(ch_size_num))
    
    random_set = sample(ch_size$chrom, size = randomSize, replace = TRUE, prob = ch_ratio)
    count_ch = plyr::count(random_set); row.names(count_ch) = count_ch$x
    count_ch = count_ch[ch_size$chrom,]
    count_ch = cbind(count_ch, ch_size_num)
    
    ran_set = apply(count_ch, 1, function(x){sample(c(1:x[3]), size = x[2], replace = FALSE, prob = NULL)})
    
    chr_ran = rep(paste0('chr', count_ch$x), count_ch$freq)
    pos_ran = unlist(ran_set)
    
    ran_tab = data.frame('Random' = c(1:randomSize), 'Random_chr' = chr_ran, 'Random_pos' = pos_ran, stringsAsFactors = FALSE)
    
    write.table(ran_tab, file = paste0(outpath, '/', outFile, '_Random_set_', organism, '_gap.txt'),
                quote = FALSE, append = FALSE, sep = '\t', na = '', row.names = FALSE, col.names = TRUE)
    
    cat('Done.\n')
  } else {}
  
  cat('---------- Creating a GRanges object ----------\n')
  
  #### 02. Make GR object by a gap table
  gr_gaps = makeGRangesFromDataFrame(dataTable, keep.extra.columns = TRUE, ignore.strand = TRUE)
  
  #### 03. Make interval GR objects of a gap table
  ranges = seq(from = range[1], to = range[2], interval)
  gr_gaps_dist = vector("list", length = (length(ranges)-1))
  for(x in 1:(length(ranges)-1)){
    tmp_start = gr_gaps@ranges@start + ranges[x]
    tmp_end = gr_gaps@ranges@start + ranges[x+1]-1
    gr_gaps_dist[[x]] = GRanges(seqnames = as.character(gr_gaps@seqnames),
                                ranges = IRanges(start = tmp_start,
                                                 end = tmp_end),
                                type = gr_gaps$type,
                                dist_label = rep(paste0(ranges[x], ' <= X < ', ranges[x+1]), length(gr_gaps)),
                                strand = '*')
  }
  
  #### 04. Make random GR object
  if(randomSet){
    tmp = ran_tab[,c(2,3,3)]
    names(tmp) = c('chr', 'start', 'end')
    gr_random = makeGRangesFromDataFrame(tmp)
  } else {
    cat("[WARN] Random distribution analysis will not be executed.\n")
  }
  
  cat('Done.\n')
  cat('---------- Annotating integrated regions  ----------\n')
  
  #### 05. Make gap information
  inside_gap = as.data.frame(findOverlaps(hits, gr_gaps, type = 'any',
                                          ignore.strand = TRUE),
                             stringsAsFactors = FALSE)
  a = as.data.frame(hits[inside_gap$queryHits,], stringsAsFactors = FALSE)
  b = dataTable[inside_gap$subjectHits,]
  inside_tab = cbind(a,b)[,c(6, 1:3, 11, 8:10)]
  names(inside_tab) = c('q_name', 'q_chr', 'q_start', 'q_end', 'type', 'chr', 'start', 'end')
  
  if(randomSet){
    inside_gap_ran = as.data.frame(findOverlaps(gr_random, gr_gaps, type = 'any', ignore.strand = TRUE), 
                                   stringsAsFactors = FALSE)
    a = as.data.frame(gr_random[inside_gap_ran$queryHits,], stringsAsFactors = FALSE)
    b = dataTable[inside_gap_ran$subjectHits,]
    inside_ran_tab = cbind(a,b)[,c(1:3, 9, 6:8)]
    names(inside_ran_tab) = c('q_chr', 'q_start', 'q_end', 'type', 'chr', 'start', 'end')
    
    dist_gap_ran = vector("list", length = length(ranges)-1)
    dist_gap_ran_tab = data.frame(stringsAsFactors = FALSE)
  } else {}
  
  dist_gap = vector("list", length = length(ranges)-1)
  dist_gap_tab = data.frame(stringsAsFactors = FALSE)
  
  for(x in 1:(length(ranges)-1)){
    dist_gap[[x]] = as.data.frame(findOverlaps(query = hits,
                                               subject = gr_gaps_dist[[x]],
                                               type = "any", ignore.strand = TRUE),
                                  stringsAsFactors = FALSE)
    a = as.data.frame(hits[dist_gap[[x]]$queryHits,], stringsAsFactors = FALSE)
    b = gr_gaps_dist[[x]][dist_gap[[x]]$subjectHits,]
    tmp1 = cbind(a,b)
    dist_gap_tab = rbind(dist_gap_tab, tmp1)
    
    if(randomSet){
      dist_gap_ran[[x]] = as.data.frame(findOverlaps(query = gr_random, subject = gr_gaps_dist[[x]], type = "any", 
                                                     ignore.strand = TRUE), stringsAsFactors = FALSE)
      a = as.data.frame(gr_random[dist_gap_ran[[x]]$queryHits,], stringsAsFactors = FALSE)
      b = gr_gaps_dist[[x]][dist_gap_ran[[x]]$subjectHits,]
      tmp1 = cbind(a,b)
      dist_gap_ran_tab = rbind(dist_gap_ran_tab, tmp1)
    } else {}
  }
  
  #### 06. Count the number of hit in each range
  count_hit_gap = vector("list", length = length(ranges)-1)
  
  if(randomSet){
    count_hit_gap_ran = vector("list", length = length(ranges)-1)
  } else {}
  
  for(x in 1:(length(ranges)-1)){
    count_hit_gap[[x]] = countOverlaps(query = hits, subject = gr_gaps_dist[[x]], type = "any", ignore.strand = TRUE)
    if(randomSet){
      count_hit_gap_ran[[x]] = countOverlaps(query = gr_random, subject = gr_gaps_dist[[x]], type = "any", ignore.strand = TRUE)
    } else {}
  }
  
  hits_gap = as.numeric(apply(as.data.frame(count_hit_gap, stringsAsFactors = FALSE), MARGIN = 2, sum))
  
  if(randomSet){
    hits_gap_ran = as.numeric(apply(as.data.frame(count_hit_gap_ran, stringsAsFactors = FALSE), MARGIN = 2, sum))
  } else {}
  
  #### 07. Drawing histograms
  ymax_g = max(hits_gap)
  
  mid = vector("numeric", length = (length(ranges)-1))
  for(x in 1:(length(ranges)-1)){
    mid[x] = (ranges[x] + ranges[x+1])/2
  }
  
  freq_sites_gap = rep(x = mid, times = hits_gap)
  
  if(randomSet){
    freq_sites_gap_ran = rep(x = mid, times = hits_gap_ran)
  } else {}
  
  dist_gap_tab = dist_gap_tab[,c(6, 1:3, 13, 8:10, 14)]; names(dist_gap_tab) = c('q_name', 'q_chr', 'q_start', 'q_end',
                                                                             'type', 'r_chr', 'r_start', 'r_end', 'range')
  
  cat('Done.\n')
  cat('---------- Drawing histograms ----------\n')
  
  count_sites_gap = plyr::count(freq_sites_gap)[,2]
  
  if(length(count_sites_gap) != 0){
    if(randomSet){
    count_sites_gap_ran = plyr::count(freq_sites_gap_ran)[,2]
    count_data = data.frame('Range' = factor(rep(ranges[ranges != 0]/1000, 2), levels = ranges[ranges != 0]/1000), 
                            'Group' = c(rep('Observed', length(count_sites_gap)), rep('Random', length(count_sites_gap_ran))),
                            'Count' = c(count_sites_gap, count_sites_gap_ran),
                            'Freq' = c(count_sites_gap/sum(count_sites_gap),
                                       count_sites_gap_ran/sum(count_sites_gap_ran)))
    
    png(paste0(outpath, '/', outFile, '_Random_distribution_gap_', organism, '.png'), width = 1200, height = 750)
    g_plot = ggplot(count_data) + geom_bar(aes(x = Range, y = Freq, fill = Group), stat = "identity", position = "dodge") +
      lims(y = c(0, max(count_data$Freq))) + ggtitle(label = "Random distribution (Gap)") +
      xlab('Intervals (Kbs)') + ylab("Ratio of Integration Events") + scale_fill_manual(values = c('Dodgerblue', 'skyblue')) +
      theme(panel.background = element_rect(fill="white", colour = "white"),
            panel.grid.major = element_line(size = 0.5, linetype = 'dotted', colour = 'black'),
            axis.line = element_line(colour = "darkgrey"), legend.title = element_blank(),
            legend.key.size = unit(0.7, "cm"), plot.title = element_text(hjust = 0.5, face = "bold", size = 15),
            legend.text = element_text(size = 13), axis.text.x = element_text(size = 12),
            axis.text.y = element_text(size = 12), axis.title.x = element_text(size = 13), axis.title.y = element_text(size = 13))
    print(g_plot)
    dev.off()
    
    result_list = vector("list", length = 4)
    result_list[[1]] = inside_tab
    result_list[[2]] = dist_gap_tab
    result_list[[3]] = dist_gap_ran_tab
    result_list[[4]] = gr_gaps
    names(result_list) = c('Gap_inside_hits', 'Gap_exp_distribution', 'Gap_random_distribution', 'Gap_data')
    
    count_table = data.frame('Ranges' = paste0(ranges[1:length(ranges)-1], ' <= X < ', ranges[2:length(ranges)]),
                             'Gene' = count_sites_gap,
                             'Random_g' = count_sites_gap_ran,
                             stringsAsFactors = FALSE)
    
    ## Difference
    prop_list_g = suppressWarnings(apply(count_table[,c(2,3)], 1, function(t){prop.test(x = c(t[1], t[2]), 
                                                                                        n = c(sum(count_sites_gap), sum(count_sites_gap_ran)), 
                                                                                        correct = FALSE)}))
    
    count_table = cbind(count_table[,c(1,2,3)], 'Gap_p_value' = round(unlist(lapply(prop_list_g, function(t){t$p.value})),3))
    
  } else {
    png(filename = paste0(outpath, '/', outFile, '_Distribution_gap_', organism, '.png'),
        width = 1200, height = 700)
    hist_freq = hist(freq_sites_gap/1000, breaks = ranges/1000, plot = FALSE)
    hist_frequency = hist(freq_sites_gap/1000, breaks = ranges/1000,
                          ylab = 'Density', xlab = "kbs", 
                          ylim = c(0, round(max(hist_freq$density),2)*1.5),
                          probability = TRUE, main = NULL, col = 'cornflowerblue',
                          axes = FALSE, cex.lab = 1.3)
    axis(side = 1, at = ranges/1000, cex.axis = 1.5)
    axis(side = 2, at = seq(0, round(max(hist_freq$density),2)*1.5, 0.01), cex.axis = 1.5)
    text(0, round(max(hist_freq$density),2)*1.5, labels = 'Gap', cex = 1.7, font = 2)
    arrows(0,0,0,round(max(hist_freq$density),2)*1.5-0.005, length = 0.15, code = 1, lwd = 3)
    arrows(min(ranges/1000), round(max(hist_freq$density),2)*1.5-0.005, range[1]/1000*0.025, round(max(hist_freq$density),2)*1.5-0.005, length = 0.1, code = 1)
    arrows(max(ranges/1000), round(max(hist_freq$density),2)*1.5-0.005, range[2]/1000*0.025, round(max(hist_freq$density),2)*1.5-0.005, length = 0.1, code = 1)
    text(range[2]/2000, round(max(hist_freq$density),2)*1.5-0.01, 'Upstream', cex = 1.5, col = 'black')
    text(-(range[2]/2000), round(max(hist_freq$density),2)*1.5-0.01, 'Downstream', cex = 1.5, col = 'black')
    dev.off()
    
    result_list = vector("list", length = 3)
    result_list[[1]] = inside_tab
    result_list[[2]] = dist_gap_tab
    result_list[[3]] = gr_gaps
    names(result_list) = c('Gap_inside_hits', 'Gap_exp_distribution', 'Gap_data')
    
    count_table = data.frame('Ranges' = paste0(ranges[1:length(ranges)-1], ' <= X < ',
                                               ranges[2:length(ranges)]),
                             'Gap' = count_sites_gap,
                             stringsAsFactors = FALSE)
  }
    ### Writing documents
    if(randomSet){
      if(!file.exists(paste0(outpath, '/', outFile, '_Distribution_results_gap_', str_remove_all(Sys.Date(), '-'), '.xlsx'))){
        writexl::write_xlsx(list(inside_gap = result_list[[1]],
                                 dist_freq = count_table,
                                 dist_gap = result_list[[2]]),
                            path = paste0(outpath, '/', outFile, '_Distribution_results_gap_', str_remove_all(Sys.Date(), '-'), '.xlsx'))
      } else {cat("[WARN] Result file can not be created because a file with the same name exists.\n")}
    } else {
      if(!file.exists(paste0(outpath, '/', outFile, '_Distribution_results_gap_noRandom_', str_remove_all(Sys.Date(), '-'), '.xlsx'))){
        writexl::write_xlsx(list(inside_gap = result_list[[1]],
                                 dist_freq = count_table,
                                 dist_gap = result_list[[2]]),
                            path = paste0(outpath, '/', outFile, '_Distribution_results_gap_noRandom_', str_remove_all(Sys.Date(), '-'), '.xlsx'))
      } else {cat("[WARN] Result file can not be created because a file with the same name exists.\n")}
    }
  } else {
    result_list = vector("list", length = 4)
    names(result_list) = c('Gap_inside_hits', 'Gap_exp_distribution', 'Gap_random_distribution', 'Gap_data')
    result_list[[4]] = gr_gaps
    cat("[WARN] There is no integration sites related with gaps.\n")
  }
  
  cat('---------- Annotation process is finished. ----------\n')
  cat(paste0('Finish time : ', date(), '\n'))
  
  return(result_list)
}