# mlr3survival

![](reference/figures/warning.png) This package is **under development**

Package website: [release](https://mlr3survival.mlr-org.com/)

Survival analysis with ‘mlr3’.

## Resources (for users and developers)

## Installation

Install the development version from GitHub:

``` r
# install.packages("pak")
pak::pak("mlr-org/mlr3survival")
```

## Example

## Code of Conduct

Please note that the mlr3survival project is released with a
[Contributor Code of
Conduct](https://mlr3survival.mlr-org.com/CODE_OF_CONDUCT.html). By
contributing to this project, you agree to abide by its terms.

# Package index

## Package

- [`mlr3survival`](https://mlr3survival.mlr-org.com/reference/mlr3survival-package.md)
  [`mlr3survival-package`](https://mlr3survival.mlr-org.com/reference/mlr3survival-package.md)
  : mlr3survival: Survival Analysis with 'mlr3'

## Building Blocks

- [`TaskSurv`](https://mlr3survival.mlr-org.com/reference/TaskSurv.md) :
  Survival Task
- [`LearnerSurv`](https://mlr3survival.mlr-org.com/reference/LearnerSurv.md)
  : Survival Learner
- [`PredictionSurv`](https://mlr3survival.mlr-org.com/reference/PredictionSurv.md)
  : Prediction Object for Survival
- [`MeasureSurv`](https://mlr3survival.mlr-org.com/reference/MeasureSurv.md)
  : Survival Measure

## Survival Tasks

- [`mlr_tasks_gbsg`](https://mlr3survival.mlr-org.com/reference/mlr_tasks_gbsg.md)
  : German Breast Cancer Study Survival Task
- [`mlr_tasks_mgus`](https://mlr3survival.mlr-org.com/reference/mlr_tasks_mgus.md)
  : Monoclonal Gammopathy Survival Task
- [`mlr_tasks_veteran`](https://mlr3survival.mlr-org.com/reference/mlr_tasks_veteran.md)
  : Veteran Survival Task
- [`mlr_tasks_lung`](https://mlr3survival.mlr-org.com/reference/mlr_tasks_lung.md)
  : Lung Cancer Survival Task
- [`mlr_tasks_rats`](https://mlr3survival.mlr-org.com/reference/mlr_tasks_rats.md)
  : Rats Survival Task

## Survival Learners

- [`mlr_learners_surv.coxph`](https://mlr3survival.mlr-org.com/reference/mlr_learners_surv.coxph.md)
  [`LearnerSurvCoxPH`](https://mlr3survival.mlr-org.com/reference/mlr_learners_surv.coxph.md)
  : Cox Proportional Hazards
- [`mlr_learners_surv.kaplan`](https://mlr3survival.mlr-org.com/reference/mlr_learners_surv.kaplan.md)
  [`LearnerSurvKaplan`](https://mlr3survival.mlr-org.com/reference/mlr_learners_surv.kaplan.md)
  : Kaplan-Meier Estimator

## Survival Measures

- [`mlr_measures_surv.cindex`](https://mlr3survival.mlr-org.com/reference/mlr_measures_surv.cindex.md)
  [`MeasureSurvCindex`](https://mlr3survival.mlr-org.com/reference/mlr_measures_surv.cindex.md)
  : Concordance Index

## Converters

- [`as_prediction_surv()`](https://mlr3survival.mlr-org.com/reference/as_prediction_surv.md)
  : Convert to a Survival Prediction
- [`as_task_surv()`](https://mlr3survival.mlr-org.com/reference/as_task_surv.md)
  : Convert to a Survival Task

## Internal Objects and Functions

- [`surv_return()`](https://mlr3survival.mlr-org.com/reference/surv_return.md)
  : Get Survival Predict Types
- [`get_mortality()`](https://mlr3survival.mlr-org.com/reference/get_mortality.md)
  : Calculate the expected mortality risks from a survival matrix