Survival Task Generator for Package 'simsurv'

A mlr3::TaskGenerator calling simsurv::simsurv() from package simsurv.

This generator currently only exposes a small subset of the flexibility of simsurv, and just creates a small dataset with the following numerical covariates:

• treatment: Bernoulli distributed with hazard ratio 0.5.

• height: Normally distributed with hazard ratio 1.

• weight: normally distributed with hazard ratio 1.

See simsurv::simsurv() for an explanation of the hyperparameters. Initial values for hyperparameters are lambdas = 0.1, gammas = 1.5 and maxt = 5. The last one, by default generates samples which are administratively censored at \(\tau = 5\), so increase this value if you want to change this.

Dictionary

This TaskGenerator can be instantiated via the dictionary mlr_task_generators or with the associated sugar function tgen():

mlr_task_generators$get("simsurv")
tgen("simsurv")

Parameters

Id	Type	Default	Levels	Range
dist	character	weibull	weibull, exponential, gompertz	-
lambdas	numeric	-		\([0, \infty)\)
gammas	numeric	-		\([0, \infty)\)
maxt	numeric	-		\([0, \infty)\)

References

Brilleman, L. S, Wolfe, Rory, Moreno-Betancur, Margarita, Crowther, J. M (2021). “Simulating Survival Data Using the simsurv R Package.” Journal of Statistical Software, 97(3), 1–27. doi:10.18637/JSS.V097.I03 .

See also

• Dictionary of TaskGenerators: mlr3::mlr_task_generators

• as.data.table(mlr_task_generators) for a table of available TaskGenerators in the running session

Other TaskGenerator: mlr_task_generators_coxed, mlr_task_generators_simdens

Super class

mlr3::TaskGenerator -> TaskGeneratorSimsurv

Methods

Public methods

• TaskGeneratorSimsurv$new()

• TaskGeneratorSimsurv$help()

• TaskGeneratorSimsurv$clone()

Inherited methods

• mlr3::TaskGenerator$format()
• mlr3::TaskGenerator$generate()
• mlr3::TaskGenerator$print()

---

Method new()

Creates a new instance of this R6 class.

Usage

TaskGeneratorSimsurv$new()

---

Method help()

Opens the corresponding help page referenced by field $man.

Usage

TaskGeneratorSimsurv$help()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

TaskGeneratorSimsurv$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

  # generate 20 samples with Weibull survival distribution
  gen = tgen("simsurv")
  task = gen$generate(20)
  head(task)
#>    eventtime status   height treatment   weight
#>        <num>  <int>    <num>     <int>    <num>
#> 1:  3.325143      1 195.5692         0 83.15862
#> 2:  5.000000      0 180.7273         1 81.94611
#> 3:  5.000000      0 158.2109         0 75.44238
#> 4:  5.000000      0 180.7542         1 88.12535
#> 5:  5.000000      0 170.5386         0 82.75043
#> 6:  1.058794      1 167.6566         0 80.06009

  # generate 100 samples with exponential survival distribution and tau = 40
  gen = tgen("simsurv", dist = "exponential", gammas = NULL, maxt = 40)
  task = gen$generate(100)
  head(task)
#>     eventtime status   height treatment    weight
#>         <num>  <int>    <num>     <int>     <num>
#> 1: 17.7686139      1 167.8120         1  90.13090
#> 2:  5.5680295      1 164.0494         0  81.73540
#> 3:  6.1518953      1 195.6015         1  69.36718
#> 4:  0.2574512      1 164.1029         0  84.85366
#> 5:  6.7569183      1 152.7731         1  68.80739
#> 6:  3.8462256      1 160.9463         0 105.33303