From 6f84c3a561b732bbefa50461fb8da698ebcee2b1 Mon Sep 17 00:00:00 2001 From: Max Kuhn Date: Tue, 18 May 2021 10:08:02 -0400 Subject: [PATCH] temporarily mark survival models as internal --- R/proportional_hazards.R | 2 +- R/survival_reg.R | 2 +- man/proportional_hazards.Rd | 2 +- man/survival_reg.Rd | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/proportional_hazards.R b/R/proportional_hazards.R index 4372162b7..24760e192 100644 --- a/R/proportional_hazards.R +++ b/R/proportional_hazards.R @@ -27,7 +27,7 @@ #' @seealso [fit()], [set_engine()], [update()] #' @examples #' show_engines("proportional_hazards") -#' +#' @keywords internal #' @export proportional_hazards <- function(mode = "censored regression", penalty = NULL, diff --git a/R/survival_reg.R b/R/survival_reg.R index 247896eb3..6d5c87a82 100644 --- a/R/survival_reg.R +++ b/R/survival_reg.R @@ -32,7 +32,7 @@ #' survival_reg() #' # Parameters can be represented by a placeholder: #' survival_reg(dist = varying()) -#' +#' @keywords internal #' @export survival_reg <- function(mode = "censored regression", dist = NULL) { diff --git a/man/proportional_hazards.Rd b/man/proportional_hazards.Rd index ce10f9d32..8f448a6de 100644 --- a/man/proportional_hazards.Rd +++ b/man/proportional_hazards.Rd @@ -48,8 +48,8 @@ For \code{proportional_hazards()}, the mode will always be "censored regression" } \examples{ show_engines("proportional_hazards") - } \seealso{ \code{\link[=fit]{fit()}}, \code{\link[=set_engine]{set_engine()}}, \code{\link[=update]{update()}} } +\keyword{internal} diff --git a/man/survival_reg.Rd b/man/survival_reg.Rd index 81929a262..80a576c6a 100644 --- a/man/survival_reg.Rd +++ b/man/survival_reg.Rd @@ -41,8 +41,8 @@ survival model be specified via the formula interface. survival_reg() # Parameters can be represented by a placeholder: survival_reg(dist = varying()) - } \seealso{ \code{\link[=fit]{fit()}}, \code{\link[survival:Surv]{survival::Surv()}}, \code{\link[=set_engine]{set_engine()}}, \code{\link[=update]{update()}} } +\keyword{internal}