Remove {SOAR}

Remove stored objects from the disc.

Description

These utilities may be used to remove objects under delayed assignment from the disc permanently, where objects are respectively held in a local cache, a central data cache or central utilities cache.

Usage

Remove(..., list = character(0),
       lib = Sys.getenv("R_LOCAL_CACHE", unset = ".R_Cache"),
       lib.loc = Sys.getenv("R_LOCAL_LIB_LOC", unset = "."))
RemoveData(...)
RemoveUtils(...)

Arguments

...

items to be removed. Names are taken as objects to be removed. Character strings, or calls resulting in character strings, are taken as providing names of items to be removed as character strings.

list

a character string vector providing the names of objects to be removed. An alternative to ... allowing the user to provide an explicit list of names.

lib

The name of the cache directory from which items are to be removed. May be given as a character string, or as a name, (i.e. without quotes) for convenience. The default is as follows:

• For Remove, the value of the R environment variable R_LOCAL_CACHE, or .R_Cache if unset,

• For RemoveData, the value of the R environment variable R_CENTRAL_DATA, or .R_Data if unset,

• For RemoveUtils, the value of the R environment variable R_CENTRAL_UTILS, or .R_Utils if unset.

lib.loc

The enclosing directory where the cache directory is to be found. The default is as follows:

• For Remove, the value of the R environment variable R_LOCAL_LIB_LOC, or the current working directory if unset,

• For RemoveDate and RemoveUtils the value of the R environment variable R_CENTRAL_LIB_LOC, or he user's HOME directory if unset.

Details

Linking the default values of lib and lib.loc to environment variables allows the user to re-set the defaults, if need be, either during startup or in the R session.

Value

Nothing. Used only for side-effects.

Note

If the cache is not presently attached to the search path, it is sliently attached at postion 2 before objects are removed from it.

Old caches made in pre-release versions of SOAR (known as ASOR) will be converted to the present format with a warning that this is happening. After this conversion only the current version of the package may be used to access the cached objects.

Author(s)

Bill Venables

References

None

See Also

rm, remove.

Examples

## change default cache, keeping any previous setting
oldLC <- Sys.getenv("R_LOCAL_CACHE", unset = ".R_Cache")
Sys.setenv(R_LOCAL_CACHE=".R_Test")

## generate some dummy data
dummy <- rnorm(100)
mn <- mean(dummy)
va <- var(dummy)

## store it in the stored object cache
Store(dummy, mn, va)
Search()
Objects()
Remove(mn, va)
Objects()
Remove(Objects())                   # empty the cache
detach(".R_Test")                   # remove from search path
Sys.setenv(R_LOCAL_CACHE=oldLC)     # restore normal default