surv_reg: Parametric survival regression

View source: R/surv_reg.R

surv_regR Documentation

Parametric survival regression

Description

[Deprecated]

This function is soft-deprecated in favor of survival_reg() which uses the "censored regression" mode.

surv_reg() defines a parametric survival model.

\Sexpr[stage=render,results=rd]{parsnip:::make_engine_list("surv_reg")}

More information on how parsnip is used for modeling is at https://www.tidymodels.org/.

Usage

surv_reg(mode = "regression", engine = "survival", dist = NULL)

Arguments

mode

A single character string for the prediction outcome mode. The only possible value for this model is "regression".

engine

A single character string specifying what computational engine to use for fitting.

dist

A character string for the probability distribution of the outcome. The default is "weibull".

Details

This function only defines what type of model is being fit. Once an engine is specified, the method to fit the model is also defined. See set_engine() for more on setting the engine, including how to set engine arguments.

The model is not trained or fit until the fit() function is used with the data.

Since survival models typically involve censoring (and require the use of survival::Surv() objects), the fit.model_spec() function will require that the survival model be specified via the formula interface.

References

https://www.tidymodels.org, Tidy Modeling with R, searchable table of parsnip models

See Also

\Sexpr[stage=render,results=rd]{parsnip:::make_seealso_list("surv_reg")}

Examples

show_engines("surv_reg")

surv_reg(mode = "regression", dist = "weibull")

parsnip documentation built on June 16, 2022, 5:10 p.m.