trex_da_control: T-Rex+DA Control Parameters

View source: R/control_parameters.R

trex_da_controlR Documentation

T-Rex+DA Control Parameters

Description

Build a control list for the dependency-aware correction of TRexDASelector.

Usage

trex_da_control(
  da_method = "BT",
  cor_coef = -2,
  rho_thr_DA = 0.02,
  hc_linkage = "single",
  hc_grid_length = 0,
  prior_groups = NULL,
  bt_selection_mode = "FeasibleOnly"
)

Arguments

da_method

Dependency model (default: "BT"). "BT", the binary tree, is made for disjoint groups of highly correlated variables. "NN", nearest neighbours, is made for overlapping groups of highly correlated variables and sweeps the correlation thresholds of a rho grid of length hc_grid_length. "AR1" is made for a first-order autoregressive dependency across the columns. "EQUI" is made for variables that all share one correlation.

cor_coef

Correlation coefficient for AR1/EQUI. -2.0 triggers auto-estimation (default: -2.0). The estimate is the mean lag-1 autocorrelation of the rows for AR1 and the mean pairwise correlation of the variables for EQUI. Both methods use the magnitude of a supplied coefficient. Any other value outside [-1, 1] gives a warning and is replaced by the estimate.

rho_thr_DA

Correlation threshold of the AR1 and EQUI methods (default: 0.02). AR1: the window around a variable reaches ceiling(log(rho_thr_DA) / log(abs(cor_coef))) columns to each side, up to the first lag whose correlation abs(cor_coef)^lag has fallen to the threshold, range [0, 1). EQUI: the correction is skipped when abs(cor_coef) does not exceed the threshold, range [0, 1].

hc_linkage

Hierarchical clustering linkage: "single", "complete", "average", "wpgma" (default: "single"). Used by BT and by prior groups. "ward" is rejected, because its update is valid for squared Euclidean distances only and the correlation distance 1 - abs(cor) is not Euclidean. The capitalized names of TRexSelector 2.0.1 ("Single") are accepted as well.

hc_grid_length

Number of correlation thresholds on the calibration grid of BT, NN and prior groups. 0 (default) takes min(20, p).

prior_groups

Optional prior grouping constraints: a list of integer vectors, each of length p, giving non-negative group labels per variable. When supplied (non-NULL, non-empty), the prior-groups dependency-aware path is used and da_method is ignored: the finest common refinement of all supplied levels acts as a hard merge constraint, hierarchical clustering (hc_linkage, correlation distance) runs within each constraint group, and the calibration rho grid (length hc_grid_length) is built from the pooled within-group dendrogram heights plus the conservative rho = 1 singleton anchor. The deflation therefore acts on tight data-driven neighbourhoods inside the known groups, never on the raw groups themselves. (default: NULL).

bt_selection_mode

Which cells of the calibration grid may win the selection of the methods BT, NN and prior groups. "FeasibleOnly" (default) admits only cells whose FDP estimate is at or below the target, which controls the realized FDR. "RFaithful" admits every cell with the largest selection count, as the 1.x versions of the package do, and can exceed the target at high within-group correlation. Ignored by AR1 and EQUI.

Value

A named list for use in TRexDASelector.

See Also

Other T-Rex selectors and controls: Gauss_data, TRexBiobankScreeningSelector, TRexDASelector, TRexGVSSelector, TRexSPCASelector, TRexScreeningSelector, TRexSelector, TRexTikhonovSelector, trex_biobank_control(), trex_build_group_centering_k(), trex_control(), trex_default_lambda2_grid(), trex_dummy_distribution(), trex_fdp(), trex_fdp_dense(), trex_gamma_to_k(), trex_get_num_threads(), trex_gvs_control(), trex_gvs_lambda2_power_rule(), trex_normalize_design(), trex_precision(), trex_recall(), trex_screen_control(), trex_spca_control(), trex_tikhonov_control(), trex_tikhonov_lambda2_power_rule(), trex_tpp(), trex_tpp_dense()

Examples

trex_da_control()
trex_da_control(da_method = "BT", hc_linkage = "average")
# Prior-groups path (constraints over p = 4 variables):
trex_da_control(prior_groups = list(c(1, 1, 2, 2)))


TRexSelector documentation built on Nov. 20, 2026, 5:09 p.m.