detect_separation_control

0th

Percentile

Auxiliary function for the glm interface when method is detect_separation.

Typically only used internally by detect_separation but may be used to construct a control argument.

Usage
detect_separation_control(
  implementation = c("ROI", "lpSolveAPI"),
  solver = "lpsolve",
  linear_program = c("primal", "dual"),
  purpose = c("find", "test"),
  tolerance = 1e-04,
  solver_control = list()
)

detectSeparationControl( implementation = c("ROI", "lpSolveAPI"), solver = "lpsolve", linear_program = c("primal", "dual"), purpose = c("find", "test"), tolerance = 1e-04, solver_control = list() )

Arguments
implementation

should the implementation using ROI or the implementation using lpSolveAPI be used? Default is ROI.

solver

should the linear program be solved using the "lpsolve" (using the ROI.plugin.lpsolve package; default) or another solver? Alternative solvers are "glpk", "cbc", "clp", "cplex", "ecos", "gurobi", "scs", "symphony". If ROI.plugin.[solver] is not installed then the user will be prompted to install it before continuing.

linear_program

should detect_separation solve the "primal" (default) or "dual" linear program for separation detection? Only relevant if implementation = "lpSolveAPI".

purpose

should detect_separation simply "test" for separation or also "find" (default) which parameters are infinite? Only relevant if implementation = "lpSolveAPI".

tolerance

maximum absolute variable value from the linear program, before separation is declared. Default is 1e-04.

solver_control

a list with additional control parameters for the "solver". This is solver specific, so consult the corresponding documentation. Default is list() unless solver is "alabama" when the default is list(start = rep(0, p)), where p is the number of parameters.

Value

A list with the supplied linear_program, solver, solver_control, purpose, tolerance, implementation, and the matched separator function (according to the value of implementation).

Aliases
  • detect_separation_control
  • detectSeparationControl
Documentation reproduced from package detectseparation, version 0.1, License: GPL-3

Community examples

Looks like there are no examples yet.