opts_Surv: Constructive options for class 'Surv'

View source: R/s3-Surv.R

opts_SurvR Documentation

Constructive options for class 'Surv'

Description

These options will be used on objects of class 'Surv'.

Usage

opts_Surv(constructor = c("Surv", "next"), ...)

Arguments

constructor

String. Name of the function used to construct the object.

...

Additional options used by user defined constructors through the opts object

Details

Depending on constructor, we construct the object as follows:

  • "Surv" (default): We build the object using survival::Surv() on the columns of the object. Interval censored data is built using type = "interval2" whenever possible, type = "interval" otherwise. Multi-state data is built by providing a factor to the event argument.

  • "next" : Use the constructor for the next supported class.

Value

An object of class <constructive_options/constructive_options_Surv>


constructive documentation built on Oct. 22, 2026, 5:07 p.m.