R/getCacheFilenameMeta.R

In nbenn/singleCellFeatures: Analyze single cell features stored in an openBIS instance

#' Get the path/filename of the metadata chache for a
#' PlateLocation/WellLocation object
#'
#' Given a PlateLocation/WellLocation object, return the path/filename of the
#' corresponding metadata chache file.
#'
#' @param a PlateLocation/WellLocation object
#' 
#' @return The path/filename of the metadata chache for a 
#'         PlateLocation/WellLocation object (as a string)
#' 
#' @examples
#' plate <- PlateLocation("J101-2C")
#' path <- getCacheFilenameMeta(plate)
#' 
#' @export
getCacheFilenameMeta <- function(x) {
  UseMethod("getCacheFilenameMeta", x)
}

#' @export
getCacheFilenameMeta.DataLocation <- function(x) {
  config <- configGet()
  name <- paste0(x$plate, "_metadata.rds")
  path <- paste(config$dataStorage$dataDir, x$space, x$group, x$experiment,
                x$plate, name, sep="/")
  return(path)
}

#' @export
getCacheFilenameMeta.default <- function(x) {
  stop("can only deal with DataLocation (PlateLocation/WellLocation) objects.")
}