Description Usage Arguments Details See Also Examples
View source: R/proportional_hazards.R
proportional_hazards()
is a way to generate a specification of a model
before fitting and allows the model to be created using different packages
in R. The main arguments for the model are:
penalty
: The total amount of regularization
in the model. Note that this must be zero for some engines.
mixture
: The mixture amounts of different types of
regularization (see below). Note that this will be ignored for some engines.
These arguments are converted to their specific names at the
time that the model is fit. Other options and arguments can be
set using set_engine()
. If left to their defaults
here (NULL
), the values are taken from the underlying model
functions. If parameters need to be modified, update()
can be used
in lieu of recreating the object from scratch.
1 2 3 4 5 6  proportional_hazards(
mode = "censored regression",
engine = "survival",
penalty = NULL,
mixture = NULL
)

mode 
A single character string for the prediction outcome mode. Possible values for this model are "unknown", or "censored regression". 
engine 
A single character string specifying what computational engine
to use for fitting. Possible engines are listed below. The default for this
model is 
penalty 
A nonnegative number representing the total amount of regularization (specific engines only). 
mixture 
A number between zero and one (inclusive) that is the
proportion of L1 regularization (i.e. lasso) in the model. When

Proportional hazards models include the Cox model.
For proportional_hazards()
, the mode will always be "censored regression".
fit.model_spec()
, set_engine()
, update()
1  show_engines("proportional_hazards")

Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.