R/getFcsFile.R

In primitybio/cellengine-r-toolkit: 'CellEngine' API Toolkit

#' Get FCS File
#'
#' Retrieves an FCS file. This retrieves metadata about the file, but does not
#' retrieve the file's contents.
#'
#' @param experimentId ID of experiment.
#' @param fcsFileId ID of FCS file.
#' @param params Optional query parameters.
#' @export
#' @examples
#' \dontrun{
#' # Retrieve by ID
#' getFcsFile(experimentId, fcsFileId)
#'
#' # Lookup by name
#' getFcsFile(experimentId, byName("Sample 1.fcs"))
#' }
getFcsFile <- function(experimentId, fcsFileId, params = list()) {
  stopIfParamIsNull(experimentId)
  experimentId <- lookupByName("/api/v1/experiments", experimentId)
  stopIfParamIsNull(fcsFileId)
  fcsFileId <- lookupByName(paste0("/api/v1/experiments/", experimentId, "/fcsfiles"), fcsFileId, "filename")
  baseGet(paste0("/api/v1/experiments/", experimentId, "/fcsfiles/", fcsFileId), params)
}