invertci.check: Checks and updates the input of the function 'invertci'

View source: R/invertci.R

invertci.checkR Documentation

Checks and updates the input of the function invertci

Description

This function checks and updates the input from the user in the invertci function. If there is any invalid input, the function will be terminated and error messages will be printed.

Usage

invertci.check(
  f,
  farg,
  alpha,
  init.lb,
  init.ub,
  tol,
  max.iter,
  pvals,
  progress
)

Arguments

f

The function that represents a testing procedure.

farg

The list of arguments to be passed to the function of testing procedure.

alpha

The significance level(s). This can be a vector.

init.lb

The initial brackets to search for the lower bound. This is not required if the chorussell is used.

init.ub

The initial brackets to search for the upper bound. This is not required if the chorussell is used.

tol

The tolerance level in the bisection method.

max.iter

The maximum number of iterations in the bisection method.

pvals

The data frame that consists the points and the corresponding p-values that have been tested in the previous iterations.

progress

The boolean variable for whether the result messages should be displayed in the procedure of constructing confidence interval. If it is set as TRUE, the messages are displayed throughout the procedure. Otherwise, the messages will not be displayed.

Value

Returns the updated parameters back to the function subsample. The following information are updated:

  • pvals

  • lb0

  • lb1

  • ub0

  • ub1


conroylau/lpinfer documentation built on Oct. 23, 2022, 9:21 a.m.