R/getRequiredParamNames.R

Defines functions getRequiredParamNames.ParamSet getRequiredParamNames.Param getRequiredParamNames

# @description
#   Returns the names of all params which are required by the given Param or ParamSet.
# @template arg_par_or_set
# @return [\code{character}]: names of parameters which are required
getRequiredParamNames = function(par) {
  UseMethod("getRequiredParamNames")
}

getRequiredParamNames.Param = function(par) {
  all.vars(par$requires)
}

getRequiredParamNames.ParamSet = function(par) {
  if (isEmpty(par)) {
    return(character(0L))
  }
  unique(unlist(lapply(par$pars, getRequiredParamNames.Param), use.names = FALSE))
}
berndbischl/ParamHelpers documentation built on Oct. 25, 2022, 10:49 p.m.