From 008fe92679dbdc7803b1db4423c26b0a8d60bbcf Mon Sep 17 00:00:00 2001 From: byron jaeger Date: Wed, 8 Nov 2023 21:57:19 -0500 Subject: [PATCH] fix example in summary --- R/orsf_summary.R | 14 +++++++------- man/orsf_summarize_uni.Rd | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/R/orsf_summary.R b/R/orsf_summary.R index c867cc64..6426cbe0 100644 --- a/R/orsf_summary.R +++ b/R/orsf_summary.R @@ -41,15 +41,15 @@ #' #' object <- orsf(pbc_orsf, Surv(time, status) ~ . - id, n_tree = 25) #' -#' # since anova importance was used to make object, we can -#' # safely say importance = 'none' and skip computation of -#' # variable importance while running orsf_summarize_uni +#' # since anova importance was used to make object, it is also +#' # used for ranking variables in the summary, unless we specify +#' # a different type of importance #' -#' orsf_summarize_uni(object, n_variables = 3, importance = 'none') +#' orsf_summarize_uni(object, n_variables = 3) #' -#' # however, if we want to summarize object according to variables -#' # ranked by negation importance, we can compute negation importance -#' # within orsf_summarize_uni() as follows: +#' # if we want to summarize object according to variables +#' # ranked by negation importance, we can compute negation +#' # importance within orsf_summarize_uni() as follows: #' #' orsf_summarize_uni(object, n_variables = 3, importance = 'negate') #' diff --git a/man/orsf_summarize_uni.Rd b/man/orsf_summarize_uni.Rd index c6f7de17..b86745b5 100644 --- a/man/orsf_summarize_uni.Rd +++ b/man/orsf_summarize_uni.Rd @@ -8,8 +8,8 @@ orsf_summarize_uni( object, n_variables = NULL, pred_horizon = NULL, - pred_type = "risk", - importance = "negate", + pred_type = NULL, + importance = NULL, ... ) }