Print method for SummarizedExperiment with tidyprint styles

Source: R/print_methods.R

Provides alternative console displays for a SummarizedExperiment object. The default shows the standard Bioconductor summary. The "tidyprint_1" design prints a compact tibble-like abstraction that preserves assay values and key covariates with a separator band when the table is truncated.

# S3 method for class 'SummarizedExperiment'
print(x, design = 2, n_print = 10, ...)

Arguments

x

A SummarizedExperiment object to print.

design

Either a character string or integer selecting the print style. Character choices are:

  • "SummarizedExperiment" — standard Bioconductor summary.

  • "tidyprint_1" — tidyprint tibble abstraction (top/bottom slices, assays | colData | rowData blocks, with an adaptive separator row).

Numeric shortcuts are mapped as:

  • 1 \(\to\) "SummarizedExperiment"

  • 2 \(\to\) "tidyprint_1"

n_print

Integer (default 10). Approximate number of rows to show in the "tidyprint_1" display. When the total cells shown are fewer than n_print, the full table is printed and the separator row is suppressed.

...

Additional arguments passed to internal printers (currently unused).

Value

x is returned invisibly after printing.

Details

The "tidyprint_1" design constructs a tibble abstraction for SummarizedExperiment data with columns: .feature, .sample, assay columns, a vertical separator "|", followed by selected colData and rowData fields. When the output is truncated, an adaptive dash-only separator row is inserted after the first half block of rows. Additional indication of colData is provided as well.

Examples

if (FALSE) { # \dontrun{
  library(tidyprint)
  print(se_airway)                         # default 
  print(se_airway, design = "tidyprint_1") # tidyprint abstraction
  print(se_airway, design = 2)             # numeric alias for "tidyprint_1"
} # }