rm.all.but: Remove all variables except those that you mention

In varhandle: Functions for Robust Variable Handling

Remove all variables except those that you mention

Description

This function removes all existing variables (in the defined environment) except the variables given to it.

Usage

    rm.all.but(keep=NULL, envir=.GlobalEnv, keep_functions=TRUE, gc_limit=100,
               regex="auto")

Arguments

keep	A vector containing the name of variables which you wish to keep and not remove or a regular expression to match variables you want to keep. Variable names and regular expressions can be used combined if the argument 'regex="auto"'. (Mandatory)
envir	The environment that this function should be functional in, search in and act in. (Optional)
keep_functions	A logical vector of length 1 indicating exclusion of function variables from removal. (optional)
gc_limit	A numeric vector of length 1 indicating the threshold for garbage collection in Megabyte (MB) scale. (Optional)
regex	A vector with length 1 to define whether the function use regular expression in keep (TRUE or FALSE) or auto detect ("auto")

Details

While working with R it happens that users generates an accumulate many variables and at some point they just want to keep some of them and remove the rest to make the workspace clean and reduce memory usage. This is where this function comes in to keep those variables user wants and remove the rest.

Two criteria can be used as filtering the variables you wish to keep:

* variable names * regular expression

These can be also used in combination in any order. You can also have multiple regular expressions to match different variable names.

The garbage collection will run if the size of removed variables exceed the 'gc_limit' parameter and will tell R to give back the amount of occupied memory by removed variables to the system. This comes handy since usually removed variables are created temporarily and removing them should free up the memory.

Author(s)

Mehrad Mahmoudian

See Also

remove gc object.size

Examples

    # create some variable
    for(i in  names(iris)){
    	assign(i, iris[,i])
    }
    # see the list of variables
    ls()
    # remove every variable except Petal.Length, Petal.Width and i
    rm.all.but(c("Petal*", "i"))
    # see which variable are left
    ls()

varhandle documentation built on Oct. 1, 2023, 1:08 a.m.