use @examplesIf where necessary

mlr-org · Oct 15, 2024 · 84a1536 · 84a1536
1 parent 563108a
commit 84a1536
Show file tree

Hide file tree

Showing 24 changed files with 37 additions and 16 deletions.
diff --git a/R/learner_mboost_regr_gamboost.R b/R/learner_mboost_regr_gamboost.R
@@ -15,8 +15,9 @@
 #' @export
 #' @template seealso_learner
 #' @examples
+#' # Define the Learner
 #' learner = lrn("regr.gamboost", baselearner = "bols")
-#' learner
+#' print(learner)
 LearnerRegrGAMBoost = R6Class("LearnerRegrGAMBoost",
   inherit = LearnerRegr,
   public = list(

diff --git a/R/learner_mgcv_classif_gam.R b/R/learner_mgcv_classif_gam.R
@@ -22,7 +22,7 @@
 #' @references
 #' `r format_bib("hastie2017generalized", "wood2012mgcv")`
 #'
-#' @examples
+#' @examplesIf requireNamespace("mgcv", quietly = TRUE)
 #' # simple example
 #' t = mlr3::tsk("spam")$filter(1:1000)
 #' l = mlr3::lrn("classif.gam")

diff --git a/R/learner_mgcv_regr_gam.R b/R/learner_mgcv_regr_gam.R
@@ -19,8 +19,7 @@
 #' @references
 #' `r format_bib("hastie2017generalized", "wood2012mgcv")`
 #'
-#' @examples
-#'
+#' @examplesIf requireNamespace("mgcv", quietly = TRUE)
 #' # simple example
 #' t = mlr3::tsk("mtcars")
 #' l = mlr3::lrn("regr.gam")

diff --git a/R/learner_partykit_classif_mob.R b/R/learner_partykit_classif_mob.R
@@ -14,7 +14,7 @@
 #'
 #' @export
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("partykit", quietly = TRUE)
 #' library(mlr3)
 #' logit_ = function(y, x, start = NULL, weights = NULL, offset = NULL, ...) {
 #'   glm(y ~ 1, family = binomial, start = start, ...)

diff --git a/R/learner_partykit_regr_mob.R b/R/learner_partykit_regr_mob.R
@@ -14,7 +14,7 @@
 #'
 #' @export
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("partykit", quietly = TRUE)
 #' library(mlr3)
 #' lm_ = function(y, x, start = NULL, weights = NULL, offset = NULL, ...) {
 #'   lm(y ~ 1, ...)

diff --git a/R/learner_randomForestSRC_classif_imbalanced_rfsrc.R b/R/learner_randomForestSRC_classif_imbalanced_rfsrc.R
@@ -16,7 +16,7 @@
 #' `r format_bib("obrien2019imbrfsrc", "chen2004imbrf")`
 #'
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("randomForestSRC", quietly = TRUE)
 #' # Define the Learner
 #' learner = mlr3::lrn("classif.imbalanced_rfsrc", importance = "TRUE")
 #' print(learner)

diff --git a/R/learner_randomForestSRC_classif_rfsrc.R b/R/learner_randomForestSRC_classif_rfsrc.R
@@ -23,7 +23,7 @@
 #' `r format_bib("breiman_2001")`
 #'
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("randomForestSRC", quietly = TRUE)
 #' # Define the Learner
 #' learner = mlr3::lrn("classif.rfsrc", importance = "TRUE")
 #' print(learner)

diff --git a/R/learner_randomForestSRC_regr_rfsrc.R b/R/learner_randomForestSRC_regr_rfsrc.R
@@ -15,7 +15,7 @@
 #' `r format_bib("breiman_2001")`
 #'
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("randomForestSRC", quietly = TRUE)
 #' # Define the Learner
 #' learner = mlr3::lrn("regr.rfsrc", importance = "TRUE")
 #' print(learner)

diff --git a/R/learner_randomForestSRC_surv_rfsrc.R b/R/learner_randomForestSRC_surv_rfsrc.R
@@ -35,7 +35,7 @@
 #' `r format_bib("ishwaran_2008", "breiman_2001")`
 #'
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("randomForestSRC", quietly = TRUE)
 #' # Define the Learner
 #' learner = mlr3::lrn("surv.rfsrc", importance = "TRUE")
 #' print(learner)

diff --git a/R/learner_randomForest_classif_randomForest.R b/R/learner_randomForest_classif_randomForest.R
@@ -13,7 +13,7 @@
 #' `r format_bib("breiman_2001")`
 #'
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("randomForest", quietly = TRUE)
 #' # Define the Learner
 #' learner = mlr3::lrn("classif.randomForest", importance = "accuracy")
 #' print(learner)

diff --git a/R/learner_randomForest_regr_randomForest.R b/R/learner_randomForest_regr_randomForest.R
@@ -13,7 +13,7 @@
 #' `r format_bib("breiman_2001")`
 #'
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("randomForest", quietly = TRUE)
 #' # Define the Learner
 #' learner = mlr3::lrn("regr.randomForest", importance = "mse")
 #' print(learner)

diff --git a/R/learner_ranger_surv_ranger.R b/R/learner_ranger_surv_ranger.R
@@ -28,7 +28,7 @@
 #' `r format_bib("wright_2017", "breiman_2001")`
 #'
 #' @template seealso_learner
-#' @examples
+#' @examplesIf requireNamespace("ranger", quietly = TRUE)
 #' # Define the Learner
 #' learner = mlr3::lrn("surv.ranger", importance = "permutation")
 #' print(learner)

diff --git a/man/mlr_learners_classif.gam.Rd b/man/mlr_learners_classif.gam.Rd
diff --git a/man/mlr_learners_classif.imbalanced_rfsrc.Rd b/man/mlr_learners_classif.imbalanced_rfsrc.Rd
diff --git a/man/mlr_learners_classif.mob.Rd b/man/mlr_learners_classif.mob.Rd
diff --git a/man/mlr_learners_classif.randomForest.Rd b/man/mlr_learners_classif.randomForest.Rd
diff --git a/man/mlr_learners_classif.rfsrc.Rd b/man/mlr_learners_classif.rfsrc.Rd
diff --git a/man/mlr_learners_regr.gam.Rd b/man/mlr_learners_regr.gam.Rd
diff --git a/man/mlr_learners_regr.gamboost.Rd b/man/mlr_learners_regr.gamboost.Rd
diff --git a/man/mlr_learners_regr.mob.Rd b/man/mlr_learners_regr.mob.Rd
diff --git a/man/mlr_learners_regr.randomForest.Rd b/man/mlr_learners_regr.randomForest.Rd
diff --git a/man/mlr_learners_regr.rfsrc.Rd b/man/mlr_learners_regr.rfsrc.Rd
diff --git a/man/mlr_learners_surv.ranger.Rd b/man/mlr_learners_surv.ranger.Rd
diff --git a/man/mlr_learners_surv.rfsrc.Rd b/man/mlr_learners_surv.rfsrc.Rd