R/updateExperiment.R

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

#' Update experiment
#'
#' Updates an experiment.
#'
#' @param experimentId ID of experiment.
#' @param properties Properties to set on the experiment.
#' @export
#' @examples
#' \dontrun{
#' updateExperiment(experimentId, list("name" = "my experiment"))
#' }
updateExperiment <- function(experimentId, properties = list()) {
  stopIfParamIsNull(experimentId)
  experimentId <- lookupByName("/api/v1/experiments", experimentId)
  body <- jsonlite::toJSON(properties, null = "null", auto_unbox = TRUE)
  basePatch(paste0("/api/v1/experiments/", experimentId), body)
}