add print methods to all functions

Author: EmilHvitfeldt

NAMESPACE

@@ -1,5 +1,23 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(print,debrief_call_depth)
+S3method(print,debrief_call_stats)
+S3method(print,debrief_callers_callees)
+S3method(print,debrief_compare)
+S3method(print,debrief_compare_many)
+S3method(print,debrief_debrief)
+S3method(print,debrief_file_summary)
+S3method(print,debrief_flame)
+S3method(print,debrief_flame_condense)
+S3method(print,debrief_focus)
+S3method(print,debrief_gc_pressure)
+S3method(print,debrief_help)
+S3method(print,debrief_hot_lines)
+S3method(print,debrief_hot_paths)
+S3method(print,debrief_memory)
+S3method(print,debrief_recursive)
+S3method(print,debrief_source_context)
+S3method(print,debrief_suggestions)
 export(pv_call_depth)
 export(pv_call_stats)
 export(pv_callees)

R/antipatterns.R

@@ -88,7 +88,8 @@ empty_gc_pressure_df <- function() {
 #' @param x A profvis object.
 #' @param threshold Minimum GC percentage to report (default 10).
 #'
-#' @return Invisibly returns the GC pressure data frame.
+#' @return Invisibly returns a `debrief_gc_pressure` object. Use
+#'   `capture.output()` to capture the formatted text output.
 #'
 #' @examples
 #' p <- pv_example("gc")
@@ -100,6 +101,18 @@ pv_print_gc_pressure <- function(x, threshold = 10) {
   check_empty_profile(x)
 
   gc_data <- pv_gc_pressure(x, threshold = threshold)
+  obj <- structure(
+    list(gc_data = gc_data, threshold = threshold),
+    class = "debrief_gc_pressure"
+  )
+  print(obj)
+  invisible(obj)
+}
+
+#' @exportS3Method
+print.debrief_gc_pressure <- function(x, ...) {
+  gc_data <- x$gc_data
+  threshold <- x$threshold
 
   cat_header("GC PRESSURE")
   cat("\n")
@@ -110,7 +123,7 @@ pv_print_gc_pressure <- function(x, threshold = 10) {
       threshold
     ))
     cat_help_hint()
-    return(invisible(gc_data))
+    return(invisible(x))
   }
 
   row <- gc_data[1, ]
@@ -128,5 +141,5 @@ pv_print_gc_pressure <- function(x, threshold = 10) {
     "pv_suggestions(p)"
   ))
 
-  invisible(gc_data)
+  invisible(x)
 }

R/call-depth.R

@@ -47,7 +47,8 @@ pv_call_depth <- function(x) {
 #'
 #' @param x A profvis object.
 #'
-#' @return Invisibly returns the call depth data frame.
+#' @return Invisibly returns a `debrief_call_depth` object. Use
+#'   `capture.output()` to capture the formatted text output.
 #'
 #' @examples
 #' p <- pv_example()
@@ -59,11 +60,19 @@ pv_print_call_depth <- function(x) {
   check_empty_profile(x)
 
   depth_df <- pv_call_depth(x)
+  obj <- structure(list(depth_df = depth_df), class = "debrief_call_depth")
+  print(obj)
+  invisible(obj)
+}
+
+#' @exportS3Method
+print.debrief_call_depth <- function(x, ...) {
+  depth_df <- x$depth_df
 
   if (nrow(depth_df) == 0) {
     cat("No profiling data available.\n")
     cat_help_hint()
-    return(invisible(depth_df))
+    return(invisible(x))
   }
 
   cat_header("CALL DEPTH BREAKDOWN")
@@ -99,5 +108,5 @@ pv_print_call_depth <- function(x) {
     }
   }
 
-  invisible(depth_df)
+  invisible(x)
 }

R/call-stats.R

@@ -120,7 +120,8 @@ estimate_call_count <- function(func, prof) {
 #' @param x A profvis object.
 #' @param n Number of functions to show.
 #'
-#' @return Invisibly returns the call stats data frame.
+#' @return Invisibly returns a `debrief_call_stats` object. Use
+#'   `capture.output()` to capture the formatted text output.
 #'
 #' @examples
 #' p <- pv_example()
@@ -132,11 +133,19 @@ pv_print_call_stats <- function(x, n = 20) {
   check_empty_profile(x)
 
   stats <- pv_call_stats(x, n = n)
+  obj <- structure(list(stats = stats), class = "debrief_call_stats")
+  print(obj)
+  invisible(obj)
+}
+
+#' @exportS3Method
+print.debrief_call_stats <- function(x, ...) {
+  stats <- x$stats
 
   if (nrow(stats) == 0) {
     cat("No profiling data available.\n")
     cat_help_hint()
-    return(invisible(stats))
+    return(invisible(x))
   }
 
   cat_header("CALL STATISTICS")
@@ -176,5 +185,5 @@ pv_print_call_stats <- function(x, n = 20) {
     }
   }
 
-  invisible(stats)
+  invisible(x)
 }

R/callers-callees.R

@@ -121,7 +121,8 @@ find_adjacent_functions <- function(
 #' @param func The function name to analyze.
 #' @param n Maximum number of callers/callees to show.
 #'
-#' @return Invisibly returns a list with `callers` and `callees` data frames.
+#' @return Invisibly returns a `debrief_callers_callees` object. Use
+#'   `capture.output()` to capture the formatted text output.
 #'
 #' @examples
 #' p <- pv_example()
@@ -141,6 +142,32 @@ pv_print_callers_callees <- function(x, func, n = 10) {
   func_total_time <- length(func_times) * pd$interval_ms
   func_pct <- round(100 * length(func_times) / pd$total_samples, 1)
 
+  obj <- structure(
+    list(
+      callers = callers,
+      callees = callees,
+      func = func,
+      func_times = func_times,
+      func_total_time = func_total_time,
+      func_pct = func_pct,
+      n = n
+    ),
+    class = "debrief_callers_callees"
+  )
+  print(obj)
+  invisible(obj)
+}
+
+#' @exportS3Method
+print.debrief_callers_callees <- function(x, ...) {
+  callers <- x$callers
+  callees <- x$callees
+  func <- x$func
+  func_times <- x$func_times
+  func_total_time <- x$func_total_time
+  func_pct <- x$func_pct
+  n <- x$n
+
   cat_header(sprintf("FUNCTION ANALYSIS: %s", func))
   cat("\n")
   cat(sprintf(
@@ -194,5 +221,5 @@ pv_print_callers_callees <- function(x, func, n = 10) {
   }
   cat_next_steps(suggestions)
 
-  invisible(list(callers = callers, callees = callees))
+  invisible(x)
 }

R/compare.R

@@ -106,7 +106,8 @@ pv_compare <- function(before, after, n = 20) {
 #' @param after A profvis object (after optimization).
 #' @param n Number of functions to show in detailed comparison.
 #'
-#' @return Invisibly returns the comparison list.
+#' @return Invisibly returns a `debrief_compare` object. Use
+#'   `capture.output()` to capture the formatted text output.
 #'
 #' @examples
 #' p1 <- pv_example()
@@ -119,6 +120,15 @@ pv_print_compare <- function(before, after, n = 15) {
   check_profvis(after)
 
   comp <- pv_compare(before, after, n = n)
+  obj <- structure(list(comp = comp, n = n), class = "debrief_compare")
+  print(obj)
+  invisible(obj)
+}
+
+#' @exportS3Method
+print.debrief_compare <- function(x, ...) {
+  comp <- x$comp
+  n <- x$n
 
   cat_header("PROFILE COMPARISON")
   cat("\n")
@@ -215,7 +225,7 @@ pv_print_compare <- function(before, after, n = 15) {
     cat_next_steps(suggestions)
   }
 
-  invisible(comp)
+  invisible(x)
 }
 
 #' Compare multiple profvis profiles
@@ -306,7 +316,8 @@ pv_compare_many <- function(...) {
 #'
 #' @param ... Named profvis objects to compare, or a single named list.
 #'
-#' @return Invisibly returns the comparison data frame.
+#' @return Invisibly returns a `debrief_compare_many` object. Use
+#'   `capture.output()` to capture the formatted text output.
 #'
 #' @examples
 #' p1 <- pv_example()
@@ -315,6 +326,14 @@ pv_compare_many <- function(...) {
 #' @export
 pv_print_compare_many <- function(...) {
   result <- pv_compare_many(...)
+  obj <- structure(list(result = result), class = "debrief_compare_many")
+  print(obj)
+  invisible(obj)
+}
+
+#' @exportS3Method
+print.debrief_compare_many <- function(x, ...) {
+  result <- x$result
 
   cat_header("MULTI-PROFILE COMPARISON")
   cat("\n")
@@ -344,5 +363,5 @@ pv_print_compare_many <- function(...) {
 
   cat("\n* = fastest\n")
 
-  invisible(result)
+  invisible(x)
 }

R/debrief.R

@@ -64,7 +64,8 @@ pv_debrief <- function(x, n = 10) {
 #' @param n_paths Number of hot paths to show (default 5).
 #' @param n_memory Number of memory hotspots to show (default 5).
 #'
-#' @return Invisibly returns the result of [pv_debrief()].
+#' @return Invisibly returns a `debrief_debrief` object. Use
+#'   `capture.output()` to capture the formatted text output.
 #'
 #' @examples
 #' p <- pv_example()
@@ -95,6 +96,52 @@ pv_print_debrief <- function(
   memory_funcs <- pv_memory(x)
   memory_lines <- if (has_source) pv_memory_lines(x) else NULL
 
+  obj <- structure(
+    list(
+      interval_ms = interval_ms,
+      total_samples = total_samples,
+      total_time_ms = total_time_ms,
+      has_source = has_source,
+      file_contents = file_contents,
+      self_time = self_time,
+      total_time = total_time,
+      hot_lines = hot_lines,
+      hot_paths = hot_paths,
+      memory_funcs = memory_funcs,
+      memory_lines = memory_lines,
+      n_functions = n_functions,
+      n_lines = n_lines,
+      n_paths = n_paths,
+      n_memory = n_memory,
+      debrief = pv_debrief(
+        x,
+        n = max(n_functions, n_lines, n_paths, n_memory)
+      )
+    ),
+    class = "debrief_debrief"
+  )
+  print(obj)
+  invisible(obj)
+}
+
+#' @exportS3Method
+print.debrief_debrief <- function(x, ...) {
+  interval_ms <- x$interval_ms
+  total_samples <- x$total_samples
+  total_time_ms <- x$total_time_ms
+  has_source <- x$has_source
+  file_contents <- x$file_contents
+  self_time <- x$self_time
+  total_time <- x$total_time
+  hot_lines <- x$hot_lines
+  hot_paths <- x$hot_paths
+  memory_funcs <- x$memory_funcs
+  memory_lines <- x$memory_lines
+  n_functions <- x$n_functions
+  n_lines <- x$n_lines
+  n_paths <- x$n_paths
+  n_memory <- x$n_memory
+
   # Print output
   cat_header("PROFILING SUMMARY")
   cat("\n")
@@ -152,7 +199,7 @@ pv_print_debrief <- function(
   suggestions <- c(suggestions, "pv_suggestions(p)", "pv_help()")
   cat_next_steps(suggestions)
 
-  invisible(pv_debrief(x, n = max(n_functions, n_lines, n_paths, n_memory)))
+  invisible(x)
 }
 
 # Print helpers for debrief

R/file-summary.R

@@ -48,7 +48,8 @@ pv_file_summary <- function(x) {
 #'
 #' @param x A profvis object.
 #'
-#' @return Invisibly returns the file summary data frame.
+#' @return Invisibly returns a `debrief_file_summary` object. Use
+#'   `capture.output()` to capture the formatted text output.
 #'
 #' @examples
 #' p <- pv_example()
@@ -60,12 +61,23 @@ pv_print_file_summary <- function(x) {
   check_empty_profile(x)
 
   summary_df <- pv_file_summary(x)
+  obj <- structure(
+    list(summary_df = summary_df),
+    class = "debrief_file_summary"
+  )
+  print(obj)
+  invisible(obj)
+}
+
+#' @exportS3Method
+print.debrief_file_summary <- function(x, ...) {
+  summary_df <- x$summary_df
 
   if (nrow(summary_df) == 0) {
     cat("No source location data available.\n")
     cat("Use devtools::load_all() to enable source references.\n")
     cat_help_hint()
-    return(invisible(summary_df))
+    return(invisible(x))
   }
 
   cat_header("FILE SUMMARY")
@@ -90,5 +102,5 @@ pv_print_file_summary <- function(x) {
     ))
   }
 
-  invisible(summary_df)
+  invisible(x)
 }