dkqs.check: Checks and updates the input in 'dkqs'

View source: R/dkqs.R

dkqs.checkR Documentation

Checks and updates the input in dkqs

Description

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

Usage

dkqs.check(data, lpmodel, beta.tgt, R, Rmulti, tau, n, solver, progress)

Arguments

data

An data frame or a matrix.

lpmodel

An lpmodel object.

beta.tgt

The value to be tested.

R

The number of bootstrap replications.

Rmulti

The multiplier for the number of bootstrap replications. The product of Rmulti and R refers to the maximum number of bootstrap replications to be conducted if there are errors.

tau

The value of the tuning parameter \tau in the DKQS procedure. This can be a vector.

n

The sample size. This is only required if data is omitted in the input.

solver

The name of the linear and quadratic programming solver that is used to obtain the solution to linear and quadratic programs. The solvers supported by this package are cplexAPI, gurobi, limSolve and Rcplex.

progress

The boolean variable for whether the progress bars should be displayed. If it is set as TRUE, the progress bars will be displayed while the code is running.

Value

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

  • data

  • lpmodel

  • solver

  • solver.name

  • test.logical

  • lb

  • ub


conroylau/lpinfer documentation built on Sept. 5, 2024, 9 p.m.