R/readDNAcopy.R

In Bioconductor/GenomicDataCommons: NIH / NCI Genomic Data Commons Access

#' Read DNAcopy results into GRanges object
#'
#' @param fname The path to a DNAcopy-like file.
#' @param ... passed to \code{\link[readr]{read_tsv}}
#' @return a \code{\link[GenomicRanges]{GRanges}} object
#' 
#' @importFrom readr read_tsv
#' @import GenomicRanges
#' @importFrom IRanges IRanges
#'
#' @examples
#' fname = system.file(package='GenomicDataCommons',
#'                     'extdata/dnacopy.tsv.gz')
#' dnac = readDNAcopy(fname)
#' class(dnac)
#' length(dnac)
#'
#' @export
readDNAcopy <- function(fname,...) {
    stopifnot(file.exists(fname))
    res = read_tsv(fname,...)
    stopifnot(ncol(res)==6)
    return(GRanges(seqnames=res[[2]],
                   ranges=IRanges(start=res[[3]],end=res[[4]]),
                   sampleName = res[[1]],
                   Num_Probes = res[[5]],
                   value      = res[[6]]))
}