AllGenerics.R

#' Get a parameter
#'
#' Accessor function for getting parameter values.
#'
#' @param object object to get parameter from.
#' @param name name of the parameter to get.
#'
#' @return The extracted parameter value
#'
#' @rdname getParam
#' @export
setGeneric("getParam", function(object, name) {standardGeneric("getParam")})

#' Set a parameter
#'
#' Function for setting parameter values.
#'
#' @param object object to set parameter in.
#' @param name name of the parameter to set.
#' @param value value to set the paramter to.
#' @param checkValid logical. Check object is valid after setting.
#'
#' @return Object with new parameter value.
#'
#' @rdname setParam
#' @export
setGeneric("setParam",
           function(object, name, value, checkValid) {
               standardGeneric("setParam")
})

#' Expand parameters
#'
#' Expand the parameters that can be vectors so that they are the same length as
#' the number of groups.
#'
#' @param object splatParams object to expand.
#' @param ... additional arguments.
#'
#' @return Expanded splatParams object.
#' @examples
#' params <- newSplatParams()
#' params <- setParams(params, groupCells = c(10, 10))
#' params
#' params <- expandParams(params)
#' params
setGeneric("expandParams", function(object, ...) {
    standardGeneric("expandParams")
})