fix errors

Author: NightlordTW

R/summary.simss.R

@@ -1,45 +1,57 @@
 #' Summary for Simulation Results
-#' @description Generates a summary of the simulation results, specifying the sample size for each comparator-endpoint
-#' @param object An object of class `"simss"` returned by a sampleSize function
+#'
+#' @description Generates a summary of the simulation results, including per-arm and total sample sizes.
+#' @param object An object of class `"simss"` returned by a sampleSize function.
 #' @param ... Additional arguments (currently unused).
 #'
-#' @return A named numeric vector with the sample size of each arm and also the total (Total) sample size.
-#' @export
+#' @return A named numeric vector with the sample size per arm and the total (Total) sample size.
+#'
+#' @author
+#' Johanna Muñoz \email{[email protected]}
+#'
+#' @export summary.simss
 #' @examples
 #' # Assume `res` is a result from `sampleSize()`
 #' # summary(res)
 summary.simss <- function(object, ...) {
+
+  if (!inherits(object, "simss")) {
+    stop("Input must be of class 'simss'")
+  }
+
   # Equivalent margins
-  margins <- data.table(names = names(unlist(object[["param.d"]][["list_lequi.tol"]])),
-                        Lower= unlist(object[["param.d"]][["list_lequi.tol"]]),
-                        Upper = unlist(object[["param.d"]][["list_uequi.tol"]]))
-  margins[, c("Comparison", "Endpoint") := tstrsplit(names, "\\.")]
+  margins <- data.table::data.table(
+    names = names(unlist(object[["param.d"]][["list_lequi.tol"]])),
+    Lower = unlist(object[["param.d"]][["list_lequi.tol"]]),
+    Upper = unlist(object[["param.d"]][["list_uequi.tol"]])
+    )
+  margins[, c("Comparison", "Endpoint") := data.table::tstrsplit(names, "\\.")]
 
+  # Header
   cat("Sample Size Summary\n")
-  cat("--------------------\n")
+  cat(strrep("-", 22), "\n")
 
-  # Sample size table
-  ss <- as.data.frame(N_ss[["response"]][, !c("power","power_LCI", "power_UCI","n_iter", "n_drop"), with = FALSE])
+  # Sample size results
+  ss <- as.data.frame(object[["response"]][, !c("power","power_LCI", "power_UCI","n_iter", "n_drop"), with = FALSE])
   ss_names <- sub("^n_", "", colnames(ss))
-  ss_names <- ifelse(ss_names == "total", "Total", ss_names)
-  colnames(ss) <- ss_names
+  colnames(ss) <- ifelse(colnames(ss) == "total", "Total", colnames(ss))
 
-  if (!inherits(object, "simss")) {
-    stop("Object must be of class 'simss'")
+  # Display design and summary
+  cat("Design type        :", object[["param.d"]][["dtype"]], "\n")
+  cat("Comparison type    :", object[["param.d"]][["ctype"]], "\n")
+  cat("Alpha              :", object[["param.d"]][["alpha"]], "\n")
+  cat("Target power       :", sprintf("%.4f", object[["param.d"]][["power"]]), "\n")
+  cat("Achieved power     :", sprintf("%.4f", object[["response"]][["power"]]), "\n")
+  if (!is.null(object$method)) {
+    cat("Method             :", object$method, "\n")
   }
 
-  cat("Design:", object[["param.d"]][["dtype"]], "\n")
-  cat("Comparison type:", object[["param.d"]][["ctype"]])
-  cat("Equivalence Margins:\n")
-  print(as.data.frame(margins[, c("Comparison", "Endpoint", "Lower", "Upper")]), row.names = FALSE)
-  cat("Alpha:", object[["param.d"]][["alpha"]], "\n")
-  cat("Target Power:", sprintf("%.4f",object[["param.d"]][["power"]]), "\n")
-  cat("Achieved Power:", sprintf("%.4f",object[["response"]][["power"]]), "\n")
-  cat("Estimated Sample Size:\n")
+  cat("\nEquivalence Margins:\n")
+  print(as.data.frame(margins[, c("Comparison", "Endpoint", "Lower", "Upper"), with = FALSE]), row.names = FALSE)
+
+  cat("\nEstimated Sample Size:\n")
   print(ss, row.names = FALSE)
-  if (!is.null(object$method)) {
-    cat("Method:", object$method, "\n")
-  }
+
   invisible(ss)
 }
 

R/zzz.R

@@ -0,0 +1 @@
+utils::globalVariables(c(":=", "setNames"))