indirect (version 0.2.1)

elicitPt: Function to create or update elicitation at a given design point.

Description

Function to create or update elicitation at a given design point.

Usage

elicitPt(
  Z,
  design.pt = NULL,
  lower.CI.bound = NA,
  median = NA,
  upper.CI.bound = NA,
  CI.prob = NULL,
  comment = " "
)

Arguments

Z

list of design with entries: theta, a \(n x 4\) matrix with columns that give lower, median and upper quantiles of the central credible interval followed by the probability CI.prob allocated to the interval; link, the link function used; and target. This list object is created by designLink

design.pt

single integer that denotes design point of interest

lower.CI.bound

scalar that gives the lower bound of the central credible interval, default NA.

median

scalar value, default NA

upper.CI.bound

scalar that gives the upper bound of the central credible interval, default NA.

CI.prob

numeric, a fraction between 0 and 1 that defines probability attributed to central credible interval. For example, 1/2 for quartiles or 1/3 for tertiles. Default NULL uses the initial CI.prob as defined by designLink.

comment

character, ASCII text providing contributed commentary associated with elicitation design point. It is recommended to avoid special characters such as quotation marks etc.

Value

Z, a list of design with entries: theta, a \(n x 4\) matrix with columns that give lower, median and upper quantiles followed by CI.prob with updated entries for row specified by argument design.pt; link, the link function used; and target.

Examples

# NOT RUN {
X <- matrix(c(1, 1, 0, 1), nrow = 2) # design
Z <- designLink(design = X)
Z <- elicitPt(Z, design.pt = 1,
  lower.CI.bound = -1,
  median = 0,
  upper.CI.bound = 1,
  comment = "A completed elicitation scenario.")
# }