fix example in summary

ropensci · Nov 9, 2023 · 008fe92 · 008fe92
1 parent ec64d60
commit 008fe92
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git 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