R/getPopulations.R

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

#' Get populations
#'
#' Retrieves the list of populations in an experiment.
#'
#' @param experimentId ID of experiment.
#' @param params Optional query parameters.
#' @export
#' @examples
#' \dontrun{
#' # List all populations in the experiment
#' getPopulations(experimentId)
#'
#' # List the names of the first five populations
#' getPopulations(experimentId, params = list("limit" = "5", "fields" = "+name"))
#' }
getPopulations <- function(experimentId, params = list()) {
  stopIfParamIsNull(experimentId)
  experimentId <- lookupByName("/api/v1/experiments", experimentId)
  baseGet(paste0("/api/v1/experiments/", experimentId, "/populations"), params)
}