Qindex: Sign-Adjusted Quantile Indices

View source: R/Qindex.R

QindexR Documentation

Sign-Adjusted Quantile Indices

Description

Sign-adjusted quantile indices based on linear and/or nonlinear functional predictors.

Usage

Qindex(formula, data, sign_prob = 0.5, ...)

Qindex_prefit_(formula, data, family, nonlinear = FALSE, ...)

Arguments

formula

formula, e.g., y~X. Response y may be double, logical and Surv. Functional predictor X is a tabulated double matrix; the rows of X correspond to the subjects, while the columns of X correspond to a common tabulating grid shared by all subjects. The numeric values of the grid are in the colnames of X

data

data.frame, must be a returned object from function clusterQp

sign_prob

double scalar between 0 and 1, user-specified probability \tilde{p} for the nearest-even quantile in the grid, which is used to determine the sign-adjustment. Default is .5, i.e., the nearest-even median of the grid

...

additional parameters for functions s and ti, most importantly k

family

family object, see function gam. Default values are

  • mgcv::cox.ph() for Surv response y;

  • binomial(link = 'logit') for logical response y;

  • gaussian(link = 'identity') for double response y

nonlinear

logical scalar, whether to use nonlinear or linear functional model. Default FALSE

Value

Function Qindex returns an Qindex object, which is an instance of an S4 class. See section Slots for details.

Slots

.Data

double vector, sign-adjusted quantile indices, see section Details of function integrandSurface

formula

see section Arguments, parameter formula

gam

a gam object

gpf

a 'gam.prefit' object, which is the returned object from function gam with argument fit = FALSE

p.value

numeric scalar, p-value for the test of significance of the functional predictor, based on slot ⁠@gam⁠

sign

double scalar of either 1 or -1, sign-adjustment, see section Details of function integrandSurface

sign_prob

double scalar, section Arguments, parameter sign_prob

Examples

# see ?`Qindex-package`

Qindex documentation built on April 4, 2025, 2:14 a.m.