Skip to contents

Fits a probit regression model for binary (incidence) responses: \(\Phi^{-1}(P(Y_i = 1)) = \beta_0 + \beta_T W_i + X_i^\top \gamma\), where \(\Phi\) is the standard normal CDF, \(W_i\) is the treatment indicator, and \(X_i\) are optional recorded covariates, by maximum likelihood (fast_probit_regression_cpp/ fast_probit_regression_weighted_cpp). Unlike InferenceIncidLogRegr's logit link, \(\hat\beta_T\) here is not an odds-ratio scale parameter: it is the treatment's additive effect on the latent standard-normal index underlying the binary outcome. likelihood_tier = "full": Wald, score, gradient, and likelihood-ratio tests are all available when the model converges, plus parametric-likelihood-bootstrap calibration of the likelihood-ratio test. A fit whose coefficients exceed max_abs_reasonable_coef in magnitude (a proxy for near-perfect separation) is cached as nonestimable rather than returned. Validity requires the usual probit assumptions: correctly specified linear predictor on the latent-normal scale, independence across subjects conditional on covariates, and no perfect/quasi-complete separation.

Computes the randomization distribution of the treatment effect estimate under the sharp null.

Whether compute_rand_two_sided_pval() is actually usable on this instance right now – FALSE exactly when it would stop(): an incidence-response instance with no custom randomization statistic and a design not eligible for design-randomization-based incidence inference (see private$should_use_design_randomization_for_incidence()). TRUE for every other case, including every non-incidence response type. Public, self-contained (only reads already-set instance state, no side effects), so InferenceSuite can check this before attempting the sentinel instead of relying on the stop() being silently swallowed into a pval = NA "ok" row – the single source of truth for both this check and compute_rand_two_sided_pval()'s own guard, so the two can never drift apart.

Value

When debug = FALSE (default), a numeric vector of length r. When debug = TRUE, a list with: values, errors (list of character vectors, one per iteration), warnings (list of character vectors, one per iteration), num_errors, num_warnings, prop_iterations_with_errors, prop_iterations_with_warnings, and prop_illegal_values.

A single logical.

References

McCullagh, P., and Nelder, J. A. (1989). Generalized Linear Models (2nd ed.). Chapman and Hall/CRC, for the binomial GLM family and probit link.

See also

InferenceIncidLogRegr for the logit-link alternative with a log-odds-ratio estimand. Comparable Python API: statsmodels GLM (family=Binomial(link=probit())). See also: Probit model (Wikipedia).

Super class

Inference -> InferenceIncidProbitRegr

Methods

+ inherited public methods from Inference


InferenceIncidProbitRegr$approximate_randomization_distribution_beta_hat_T()

Usage

InferenceIncidProbitRegr$approximate_randomization_distribution_beta_hat_T(
  r = 501,
  delta = 0,
  transform_responses = "none",
  show_progress = TRUE,
  permutations = NULL,
  debug = FALSE,
  zero_one_logit_clamp = .Machine$double.eps
)

Arguments

r

Number of randomization vectors. Default 501.

delta

The null difference. Default 0.

transform_responses

Type of transformation. Default "none".

show_progress

Show progress bar. Default TRUE.

permutations

Pre-computed permutations. Default NULL.

debug

If TRUE, return a list with the distribution values and per-iteration diagnostics including error messages, warning messages, counts of each, and summary proportions for iterations with errors, warnings, and illegal (non-finite) values. Runs serially. Default FALSE.

zero_one_logit_clamp

The clamping amount for exact 0 and 1 values when logging


InferenceIncidProbitRegr$supports_rand_pval_for_incidence()

Usage

InferenceIncidProbitRegr$supports_rand_pval_for_incidence()


InferenceIncidProbitRegr$clone()

The objects of this class are cloneable with this method.

Usage

InferenceIncidProbitRegr$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# \donttest{
seq_des = DesignSeqOneByOneBernoulli$new(n = 10, response_type = 'incidence')
for (i in 1:10) {
  seq_des$add_one_subject_to_experiment_and_assign(data.frame(x1 = rnorm(1)))
}
seq_des$add_all_subject_responses(rbinom(10, 1, 0.5))
inf = InferenceIncidProbitRegr$new(seq_des)
inf$compute_estimate()
#> [1] -6.051287
# }