parsnip: A Common API to Modeling and Analysis Functions

For this engine, there is a single mode: censored regression

This model has one engine-specific tuning parameter:

k: Number of knots in the spline. The default is k = 0.

The censored extension package is required to fit this model.

library(censored)

survival_reg() %>% 
  set_engine("flexsurvspline") %>% 
  set_mode("censored regression") %>% 
  translate()

## Parametric Survival Regression Model Specification (censored regression)
## 
## Computational engine: flexsurvspline 
## 
## Model fit template:
## flexsurv::flexsurvspline(formula = missing_arg(), data = missing_arg(), 
##     weights = missing_arg())

The main interface for this model uses the formula method since the model specification typically involved the use of [survival::Surv()].

For this engine, stratification cannot be specified via [survival::strata()], please see [flexsurv::flexsurvspline()] for alternative specifications.

Predictions of type "time" are predictions of the mean survival time.

This model can utilize case weights during model fitting. To use them, see the documentation in [case_weights] and the examples on tidymodels.org.

The fit() and fit_xy() arguments have arguments called case_weights that expect vectors of case weights.

This model object contains data that are not required to make predictions. When saving the model for the purpose of prediction, the size of the saved object might be substantially reduced by using functions from the butcher package.