store.objects: Stores all local objects of the calling environment to be...

Description Usage Arguments Value

Description

Stores all local objects of the calling environment to be able to restore them later when debugging. Is used by restore.point

Usage

1
2
3
4
5
store.objects(name = NULL, parent.num = -1,
  deep.copy = get.restore.point.options()$deep.copy, force = FALSE,
  store.if.called.from.global = FALSE, envir = sys.frame(parent.num),
  store.parent.env = "all.but.global", dots = eval(substitute(list(...), env
  = parent.frame())))

Arguments

name

key under which the objects are stored, typical the name of the calling function. If name is NULL by default the name of the calling function is chosen

parent.num

can be used to specify envir=sys.frame(parent.num)

deep.copy

if TRUE (default) variables that are copied by reference (in the moment environments) will be stored as deep copy. May take long for large variables but ensures that the value of the stored variable do not change

force

store even if do.store(FALSE) has been called

store.if.called.from.global

if the function is called from the global environment and store.if.called.from.global FALSE (default) does not store objects when called from the global environment but does nothing instead.

envir

the environment from which objects shall be stored. By default the local environemnt of the calling function.

store.parent.env

shall objects from enclosing environments of envir also be stored? So far this happens for all enclosing environments except for the global environment or baseenv.

dots

by default a list of the ... argument of the function in whicht restore.point was called

Value

returns nothing, just called for side effects


restorepoint documentation built on April 14, 2017, 4:47 p.m.