separation_qc: A quick check for separation.

View source: R/overlap_fc.R

separation_qcR Documentation

A quick check for separation.

Description

A quick check for separation.

Usage

separation_qc(
  y,
  X,
  S,
  rational = FALSE,
  model = c("b", "bcl", "cl", "acl", "sl", "osm"),
  backend = c("rcdd", "ROI"),
  solver = NULL
)

Arguments

y

outcome vector.

X

design matrix.

S

structure vector matrix

rational

should rational arithmetic be used?

model

what model class is intended to be fitted? Can be any of "b" for binary, "bcl" for baseline-category link, "cl" for cumulative link, "acl" for adjacent-category link. "sl" for sequential link, "osm" for ordered stereotype model. If missing it defaults to cumulative link for ordinal y and baseline-category for everything else.

backend

which backend to use for the linear program. Can be 'rcdd' (default and only option for rational=TRUE) or 'ROI'.

solver

the solver to be used in the backend. Defaults to "DualSimplex" for "rcdd" and the first LP solver returned by 'ROI_applicable_solver()' for "ROI".

Value

a Boolean; either 'TRUE' if we detect overlap or 'FALSE' if we do not (so the data show separation).


divoRce documentation built on April 28, 2026, 3:01 p.m.