Pull Request by Zilin Huang regarding Issue #216

R/ggcuminc.R

@@ -55,6 +55,14 @@ ggcuminc <- function(x, outcome = NULL,
     )
   }
 
+  # Generate an error if the input is a `survfit.coxphms` regression model: ----
+  if (inherits(x, "survfitcoxms")) {
+    cli_abort(
+      "Argument {.arg x} does not support {.cls survfit.coxphms} object.
+  Please fit a multi-state model with another project, such as {.fn coxph}."
+    )
+  }
+
   # prep data to be passed to ggplot() -----------------------------------------
   if (inherits(x, "tidycuminc"))
     df <- tidy_cuminc(x = x)
@@ -69,7 +77,7 @@ ggcuminc <- function(x, outcome = NULL,
     cli_inform("Plotting outcome {.val {outcome}}.")
   }
   if (any(!outcome %in% unique(df$outcome))) {
-    cli_abort("Argument {.code outcome} must be one or more of {.val {unique(df$outcome)}}")
+    cli_abort("Argument {.arg x} does not support {.cls survfit.coxphms} object.")
   }
   df <- dplyr::filter(df, .data$outcome %in% .env$outcome)
 

R/scale_ggsurvfit.R

@@ -34,8 +34,23 @@
 #' # specify additional scales
 #' ggsurvfit +
 #'   scale_ggsurvfit(x_scales = list(breaks = seq(0, 8, by = 2)))
+#'
+#' @details
+#' Specical case: in the risk table, large numbers (with more than 4 digits) may not
+#' be shown completely, with some digits truncated outside the plot region.
+#' To remedy this, consider the following example code for a simulated large-size survival dataset:
+#' Here, adjust the expand size in `scale_ggsurvfit(x_scales = list(expand = c(0.05, 0)))` (for example)
+#' can modify the position of numbers in the risk table
+#' and make them all fit in the plot region. The scale of the `expand` argument differs by cases.
+#'
+#' df_colon_large <- df_colon[sample(1:nrow(df_colon), size = 15*nrow(df_colon), replace = TRUE), ]
+#' ggsurvfit <-
+#'   survfit2(Surv(time, status) ~ surg, data = df_colon_large) %>%
+#'   ggsurvfit() + add_risktable() +
+#'   scale_ggsurvfit()
 #' @inherit ggsurvfit seealso
-scale_ggsurvfit <- function(x_scales = list(), y_scales = list()){
+scale_ggsurvfit <-
+  function(x_scales = list(), y_scales = list()){
   scale_ggsurvfit_empty_list <- list()
   structure(scale_ggsurvfit_empty_list, x_scales = x_scales, y_scales = y_scales, class = "scale_ggsurvfit")
 }

R/utils-add_risktable.R

@@ -18,7 +18,7 @@
   }
 
   # get data to place in risktables --------------------------------------------
-  times <- times %||% plot_build$layout$panel_params[[1]]$x.sec$breaks
+  times <- times %||% plot_build$layout$panel_params[[1]]$x$breaks
   df_times <-
     .prepare_data_for_risk_tables(data = x$data, times = times, combine_groups = combine_groups)