purge_help: Purge objects and parts of objects

In j-martineau/uj: Utilities by JAM

Purge objects and parts of objects

Description

Purge objects and parts of objects

Usage

purge_help()

purge(...)

x(...)

purge_plots(x = NULL)

rm_plot(x = NULL)

xplot(x = NULL)

purge_plot(x = NULL)

rm_plots(x = NULL)

xplots(x = NULL)

purge_warnings()

purge_warn()

xwarnings()

xwarn()

purge_console()

purge_con()

xconsole()

xcon()

purge_global()

purge_all()

rm_global()

rm_all()

xglobal()

xall()

Arguments

...	One or more complete character vecs containing names of objects to purge from the global environment.
x	Anticipated to be a plot object, but any object can be handled.
funs	A complete character vec of function names, possibly with package prefixes.

Details

All purge (x) functions include garbage collection.

⁠purge_plot, rm_plot, xplot⁠
⁠purge_warn, rm_warn, xwarn⁠	Purge warnings
⁠purge_con, rm_con, xcon⁠	Purge console
⁠purge, x⁠

^{(1)} Converts 'base::paste' to 'paste', for example.

^{(2)} Followed by printing the object x if not NULL.

⁠purge_global, purge_all⁠	WARNING: Use with care!
⁠rm_global, rm_all⁠	*These functions purge *
⁠xglobal, xall⁠	the global environment

Value

A character vector

⁠purge_pref, rm_pref, xpref⁠

The NULL object

all others

Functions

• purge(): Purge specific objects as named in ... (unquoted object names).

• x(): An aliase for purge.

• purge_plots(): Closes all open plots/graphic devices, followed by printing x if not NULL.

• rm_plot(): An alias for purge_plot.

• xplot(): An alias for purge_plot.

• purge_plot(): An alias for purge_plot.

• rm_plots(): An alias for purge_plot.

• xplots(): An alias for purge_plot.

• purge_warnings(): Purges warning messages.

• purge_warn(): An alias for purge_warnings.

• xwarnings(): An alias for purge_warnings.

• xwarn(): An alias for purge_warnings.

• purge_console(): Purges the contents of the console.

• purge_con(): An alias for purge_console.

• xconsole(): An alias for purge_console.

• xcon(): An alias for purge_console.

• purge_global(): Purges the global environment.

• purge_all(): An alias for purge_global.

• rm_global(): An alias for purge_global.

• rm_all(): An alias for purge_global.

• xglobal(): An alias for purge_global.

• xall(): An alias for purge_global.

See Also

Other meta: callers(), console_help(), dot_args(), pause(), ply_help(), recycling_help(), run()

Other purge: rm_vals_help()

Examples

egFunNames <- c("base::c", "uj::cmp_chr_scl", "run")
xpref(egFunNames)
## Not run: 
  ## build a ggplot scatterplot object (y.)
  library(ggplot2)
  egObj <- data.frame(x = 0:100, y = sqrt(0:100)
  egGgp <- ggplot(egObj, aes(x, y)) + geom_point()

  ## print to console, wait for user, purge console
  say("\n A message")
  continue()
  xcon()

  ## display a scatterplot, wait for user
  plot(egObj$x, egObj$y)
  continue()

  ## purge plots and print ggplot
  xplot(egGgp)

  ## wait for user, purge plots again
  continue()
  xplot()

  ## generate warning, print warnings
  sqrt(-1)
  warnings()

  ## purge warnings, validate that warnings are purged
  xwarn()
  warnings()

## End(Not run)

j-martineau/uj documentation built on Sept. 14, 2024, 4:40 a.m.