R/getScaleSets.R

Defines functions getScaleSets

Documented in getScaleSets

#' Get scale sets
#'
#' Retrieves the list of scale sets in an experiment. Currently each experiment
#' has exactly one scale set.
#'
#' @param experimentId ID of experiment.
#' @param params Optional query parameters.
#' @export
#' @examples
#' \dontrun{
#' getScaleSets(experimentId)
#' }
getScaleSets <- function(experimentId, params = list()) {
  stopIfParamIsNull(experimentId)
  experimentId <- lookupByName("/api/v1/experiments", experimentId)
  baseGet(paste0("/api/v1/experiments/", experimentId, "/scalesets"), params)
}
primitybio/cellengine-r-toolkit documentation built on Oct. 19, 2024, 1:17 a.m.