GetParamInfoFromAdjustSpec {hivPlatform}R Documentation

GetParamInfoFromAdjustSpec

Description

Extract parameters from an adjustment specification. Values are provided as a list.

Usage

GetParamInfoFromAdjustSpec(paramSpecs, infoType = "value")

Arguments

paramSpecs

List of parameter specifications. Required.

infoType

Type of information to extract from the parameter specification. Optional. Default = "value".

Value

List of parameters of shape [paramName] = [paramValue]

Examples

paramSpecs <- list(
  nimp = list(
    label = "Number of imputations",
    input = "numeric",
    value = 2
  )
)
GetParamInfoFromAdjustSpec(paramSpecs)
# $nimp
# [1] 2

GetParamInfoFromAdjustSpec(paramSpecs, infoType = "label")
GetParamInfoFromAdjustSpec(paramSpecs, infoType = "input")


[Package hivPlatform version 2.0.5 Index]