Skip to content

Commit 8ac199a

Browse files
committed
use template for extra info on linear predictor
1 parent 0af9c86 commit 8ac199a

File tree

5 files changed

+13
-18
lines changed

5 files changed

+13
-18
lines changed

man/rmd/proportional_hazards_glmnet.Rmd

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,8 @@ predict(mod, pred_data, type = "survival", time = 500) %>%
8585
Note that columns used in the `strata()` function _will_ also be estimated in the regular portion of the model (i.e., within the linear predictor).
8686

8787
# Linear predictor values
88-
89-
Since risk regression and parametric survival models are modeling different characteristics (e.g. relative hazard versus event time), their linear predictors will be going in opposite directions.
90-
91-
For example, for parametric models, the linear predictor _increases with time_. For proportional hazards models the linear predictor _decreases with time_ (since hazard is increasing). As such, the linear predictors for these two quantities will have opposite signs.
92-
93-
tidymodels does not treat different models differently when computing performance metrics. To standardize across model types, the default for proportional hazards models is to have _increasing values with time_. As a result, the sign of the linear predictor will be the opposite of the value produced by the `predict()` method in the \pkg{survival} package.
94-
95-
This behavior can be changed by using the `increasing` argument when calling `predict()` on a \pkg{parsnip} model object.
88+
```{r child = "template-censored-linear-predictor.Rmd"}
89+
```
9690

9791
# References
9892

man/rmd/proportional_hazards_glmnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Since risk regression and parametric survival models are modeling different char
101101

102102
For example, for parametric models, the linear predictor _increases with time_. For proportional hazards models the linear predictor _decreases with time_ (since hazard is increasing). As such, the linear predictors for these two quantities will have opposite signs.
103103

104-
tidymodels does not treat different models differently when computing performance metrics. To standardize across model types, the default for proportional hazards models is to have _increasing values with time_. As a result, the sign of the linear predictor will be the opposite of the value produced by the `predict()` method in the \pkg{survival} package.
104+
tidymodels does not treat different models differently when computing performance metrics. To standardize across model types, the default for proportional hazards models is to have _increasing values with time_. As a result, the sign of the linear predictor will be the opposite of the value produced by the `predict()` method in the engine package.
105105

106106
This behavior can be changed by using the `increasing` argument when calling `predict()` on a \pkg{parsnip} model object.
107107

man/rmd/proportional_hazards_survival.Rmd

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,8 @@ Note that columns used in the `strata()` function will not be estimated in the r
4444

4545

4646
# Linear predictor values
47-
48-
Since risk regression and parametric survival models are modeling different characteristics (e.g. relative hazard versus event time), their linear predictors will be going in opposite directions.
49-
50-
For example, for parametric models, the linear predictor _increases with time_. For proportional hazards models the linear predictor _decreases with time_ (since hazard is increasing). As such, the linear predictors for these two quantities will have opposite signs.
51-
52-
tidymodels does not treat different models differently when computing performance metrics. To standardize across model types, the default for proportional hazards models is to have _increasing values with time_. As a result, the sign of the linear predictor will be the opposite of the value produced by the `predict()` method in the \pkg{survival} package.
53-
54-
This behavior can be changed by using the `increasing` argument when calling `predict()` on a \pkg{parsnip} model object.
47+
```{r child = "template-censored-linear-predictor.Rmd"}
48+
```
5549

5650
## References
5751

man/rmd/proportional_hazards_survival.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Since risk regression and parametric survival models are modeling different char
9191

9292
For example, for parametric models, the linear predictor _increases with time_. For proportional hazards models the linear predictor _decreases with time_ (since hazard is increasing). As such, the linear predictors for these two quantities will have opposite signs.
9393

94-
tidymodels does not treat different models differently when computing performance metrics. To standardize across model types, the default for proportional hazards models is to have _increasing values with time_. As a result, the sign of the linear predictor will be the opposite of the value produced by the `predict()` method in the \pkg{survival} package.
94+
tidymodels does not treat different models differently when computing performance metrics. To standardize across model types, the default for proportional hazards models is to have _increasing values with time_. As a result, the sign of the linear predictor will be the opposite of the value produced by the `predict()` method in the engine package.
9595

9696
This behavior can be changed by using the `increasing` argument when calling `predict()` on a \pkg{parsnip} model object.
9797

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Since risk regression and parametric survival models are modeling different characteristics (e.g. relative hazard versus event time), their linear predictors will be going in opposite directions.
2+
3+
For example, for parametric models, the linear predictor _increases with time_. For proportional hazards models the linear predictor _decreases with time_ (since hazard is increasing). As such, the linear predictors for these two quantities will have opposite signs.
4+
5+
tidymodels does not treat different models differently when computing performance metrics. To standardize across model types, the default for proportional hazards models is to have _increasing values with time_. As a result, the sign of the linear predictor will be the opposite of the value produced by the `predict()` method in the engine package.
6+
7+
This behavior can be changed by using the `increasing` argument when calling `predict()` on a \pkg{parsnip} model object.

0 commit comments

Comments
 (0)