getParamIds: Return ids of parameters in parameter set.

View source: R/getParamIds.R

getParamIdsR Documentation

Return ids of parameters in parameter set.

Description

Useful if vectors are included.

Usage

getParamIds(par, repeated = FALSE, with.nr = FALSE)

Arguments

par

(Param | ParamSet)
Parameter or parameter set.

repeated

(logical(1))
Should ids be repeated length-times if parameter is a vector? Default is FALSE.

with.nr

(logical(1))
Should number from 1 to length be appended to id if repeated is TRUE? Otherwise ignored. Default is FALSE.

Value

character.

Examples

ps = makeParamSet(
  makeNumericParam("u"),
  makeIntegerVectorParam("v", len = 2)
)
getParamIds(ps)
getParamIds(ps, repeated = TRUE)
getParamIds(ps, repeated = TRUE, with.nr = TRUE)

ParamHelpers documentation built on July 4, 2022, 5:07 p.m.