R/get_demo_file.R

#' Get the file path to a specific file format demo file.
#'
#' Available format:
#'   * bed
#'   * narrowPeak
#'   * broadPeak
#'
#' @param format The file format to return. Default: "bed"
#'
#' @return The path to the file corresponding to the specified file format.
#'
#' @examples
#' get_demo_file() # Return path to bed file by default
#' get_demo_file(format = "narrowPeak")
#'
#' @export
get_demo_file <- function(format = c("bed", "narrowPeak", "broadPeak")) {
  format <- match.arg(format)
  if (format == "bed") {
    return(system.file("extdata/demo.bed",
                       package = "GenomicFormatExamples"))
  } 
  if (format == "narrowPeak") {
    return(system.file("extdata/demo.narrowPeak",
                       package = "GenomicFormatExamples"))
  } 
  if (format == "broadPeak") {
    return(system.file("extdata/demo.broadPeak",
                       package = "GenomicFormatExamples"))
  } 
}
CharlesJB/GenomicFormatExamples documentation built on May 6, 2019, 9:58 a.m.