mvbutils: dont.lockBindings – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

dont.lockBindings

Helper for live-editing of packages

Description

Normally, objects in a NAMESPACEd package are locked and can't be changed. Sometimes this isn't what you want; you can prevent it by calling dont.lockBindings in the .onLoad for the package. For user-visible objects (i.e. things that end up in the "package:blah" environment on the search path), you can achieve the same effect by calling dont.lockBindings in the package's .onAttach function, with namespace=FALSE.

Usage

dont.lockBindings( what, pkgname, namespace.=TRUE)

Arguments

`what`	(character) the names of the objects to not lock.
`pkgname`	(string) the name of the package. As you will only use this inside `.onLoad`, you can just set this to `pkgname` which is an argument of `.onLoad`.
`namespace.`	TRUE to antilock in the namespace during `.onLoad`; FALSE to antilock in the visible manifestation of the package.

Details

Locking occurs after .onLoad / .onAttach are called so, to circumvent it, dont.lockBindings creates a hook function to be called after the locking step.

Examples

## Not run: 
library( debug)
debug:::.onLoad # d.lB is called to make 'tracees' editable inside 'debug's namespace.
debug:::.onAttach # d.lB is called to make 'tracees' editable in the search path
# NB also that an active binding is used to ensure that the 'tracees' object in the search...
#... path is a "shadow of" or "pointer to" the one in 'debug's namespace; the two cannot get...
#... out-of-synch

## End(Not run)

mvbutils

Workspace Organization, Code and Documentation Editing, Package Prep and Editing, Etc

v2.8.232

GPL (>= 2)

Authors

Mark V. Bravington <mark.bravington@csiro.au>

Initial release

2018-12-11