Skip to content

Commit

Permalink
add more references
Browse files Browse the repository at this point in the history
  • Loading branch information
bblodfon committed Oct 22, 2024
1 parent babe1e0 commit 3798822
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 0 deletions.
2 changes: 2 additions & 0 deletions R/PipeOpBreslow.R
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
#' This is useful for changing the prediction `distr` from one model form to
#' another.
#' @seealso [pipeline_distrcompositor]
#' @references
#' `r format_bib("cox_1972", "lin_2007")`
#' @export
#' @family survival compositors
#' @examplesIf mlr3misc::require_namespaces(c("mlr3pipelines"), quietly = TRUE)
Expand Down
2 changes: 2 additions & 0 deletions R/TaskGeneratorCoxed.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
#' @template task_generator
#'
#' @template seealso_task_generator
#' @references
#' `r format_bib("harden_2019")`
#' @examplesIf mlr3misc::require_namespaces(c("coxed"), quietly = TRUE)
#' library(mlr3)
#'
Expand Down
2 changes: 2 additions & 0 deletions R/TaskGeneratorSimsurv.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
#' @template task_generator
#'
#' @template seealso_task_generator
#' @references
#' `r format_bib("brilleman_2021")`
#' @examplesIf mlr3misc::require_namespaces(c("simsurv"), quietly = TRUE)
#' # generate 20 samples with Weibull survival distribution
#' gen = tgen("simsurv")
Expand Down
5 changes: 5 additions & 0 deletions R/pipelines.R
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,8 @@ pipeline_survtoregr = function(method = 1, regr_learner = lrn("regr.featureless"
#' 4. Optionally: [PipeOpModelMatrix][mlr3pipelines::PipeOpModelMatrix] is used to transform the formula of the task
#' before fitting the learner.
#'
#' @references
#' `r format_bib("tutz_2016")`
#' @examplesIf mlr3misc::require_namespaces(c("mlr3pipelines", "mlr3learners"), quietly = TRUE)
#' \dontrun{
#' library(mlr3)
Expand Down Expand Up @@ -636,6 +638,9 @@ pipeline_survtoclassif_disctime = function(learner, cut = NULL, max_time = NULL,
#' 3. [PipeOpPredClassifSurvIPCW] transforms the resulting [PredictionClassif][mlr3::PredictionClassif]
#' to [PredictionSurv].
#'
#' @references
#' `r format_bib("vock_2016")`
#'
#' @examplesIf mlr3misc::require_namespaces(c("mlr3pipelines", "mlr3learners"), quietly = TRUE)
#' \dontrun{
#' library(mlr3)
Expand Down
6 changes: 6 additions & 0 deletions man/mlr_graphs_survtoclassif_IPCW.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions man/mlr_graphs_survtoclassif_disctime.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions man/mlr_pipeops_compose_breslow_distr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions man/mlr_task_generators_coxed.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions man/mlr_task_generators_simsurv.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3798822

Please sign in to comment.