PhecapSurrogate {PheCAP}

Define a Surrogate Variable used in Surrogate-Assisted Feature Extraction (SAFE)

Description

Define a surrogate varible from existing features, and specify associated lower and upper cutoffs.

Usage

PhecapSurrogate(variable_names, lower_cutoff = 1L, upper_cutoff = 10L)

Arguments

variable_names

a character scalar or vector consisting of variable names. If a vector is given, the value of the surrogate is defined as the sum of the values of each variable.

lower_cutoff

a numeric scalar. If the surrogate value of a patient is less than or equal to this cutoff, then this patient is treated as a control in SAFE.

upper_cutoff

a numeric scalar. If the surrogate value of a patient is greater than or equal to this cutoff, then this patient is treated as a case in SAFE.

Details

This function only stores the definition. No calculation is done.

Value

An object of class PhecapSurrogate.

See Also

See PheCAP-package for code examples.