foldAllBr: Easily Fold Code Parts

View source: R/foldAllBr.R

foldAllBrR Documentation

Easily Fold Code Parts

Description

This function works with code split into parts identified by brackets. The format is as follows:

{
  ...
  code from part 1
  ...
} # part 1
{
  ...
} # part 2

It automatically identifies parts to fold/unfold easily.

Shortcuts required:

  • "fold all brackets": shift + alt + S (Windows) / ctrl + shift + up (Mac)

  • "expand fold": shift + alt + D (Windows) / ctrl + shift + down (Mac)

Usage

foldAllBr(time = FALSE, debug_getTbl = FALSE)

Arguments

time

Logical. If 'TRUE', the function will return ggplot object visualizing execution times for each step.

debug_getTbl

Logical. If 'TRUE', returns the 'docContent' table with tags for debugging purposes.

Value

A list containing:

  • debug_info: A data frame with debugging information if debug_getTbl = TRUE.

  • timer_plot: A ggplot object visualizing execution times if time = TRUE.

If both parameters are FALSE, the function returns a list with NULL values.


R.AlphA.Home documentation built on April 3, 2025, 5:53 p.m.