Enable or disable tidy print for SummarizedExperiment objects

Source: R/tidy_print_toggle.R

These functions control whether SummarizedExperiment objects use the custom tidy print format or the standard Bioconductor print format. By default, standard print is used.

tidy_print_on(remember = FALSE)

tidy_print_off(remember = FALSE)

tidy_print_enabled()

Arguments

remember

Logical (default FALSE). If TRUE, saves the setting to a local cache file so it persists across R sessions. If FALSE, the setting only affects the current R session.

Value

  • tidy_print_on(): Returns TRUE invisibly after enabling tidy print

  • tidy_print_off(): Returns FALSE invisibly after disabling tidy print

  • tidy_print_enabled(): Returns a logical indicating whether tidy print is currently enabled

Details

The tidy print format provides a compact tibble-like display that combines assay data with sample and feature metadata. The standard print format is the default Bioconductor display.

When tidy print is enabled, SummarizedExperiment objects will display using the custom tibble abstraction format. When disabled (default), they will use the standard SummarizedExperiment print method from the Bioconductor package.

The setting is stored in the global R options as tidyprint.use_tidy_print. When remember = TRUE, the setting is also saved to a cache file in the user's R configuration directory, which takes precedence over the option. The cache file location is determined by tools::R_user_dir("tidyprint", "config").

Examples

  # Check current status
  tidy_print_enabled()
#> [1] FALSE

  # Enable tidy print (session only)
  tidy_print_on()
#> ℹ tidyprint says: Tidy print enabled for this session only. Use tidy_print_on(remember = TRUE) to save this setting for future sessions.

  # Enable tidy print and remember the setting (saved to cache)
  tidy_print_on(remember = TRUE)

  # Disable tidy print (use standard print)
  tidy_print_off()
#> ℹ tidyprint says: Tidy print disabled for this session. Use tidy_print_off(remember = TRUE) to save this setting for future sessions.

  # Disable tidy print and remember the setting
  tidy_print_off(remember = TRUE)