ID EN
…
Environment & Scope

get

R Base 3.6.2

Search by name for an object (get) or zero or more objects (mget).

Syntax

R 
get(x, pos = -1, envir = as.environment(pos), mode = "any",
    inherits = TRUE)<p></p><p>mget(x, envir = as.environment(-1), mode = "any", ifnotfound,
     inherits = FALSE)</p><p>dynGet(x, ifnotfound = , minframe = 1L, inherits = FALSE)</p>

Arguments

Parameter Description
x For get, an object name (given as a character string). For mget, a character vector of object names.
pos, envir where to look for the object (see ‘Details’); if omitted search as if the name of the object appeared unquoted in an expression.
mode the mode or type of object sought: see the ‘Details’ section.
inherits should the enclosing frames of the environment be searched?
ifnotfound For mget, a list of values to be used if the item is not found: it will be coerced to a list if necessary. For dynGet any R object, e.g., a call to stop().
minframe integer specifying the minimal frame number to look into.

Return Value

For get, the object found. If no object is found an error results. For mget, a named list of objects (found or specified via ifnotfound).

Details

The pos argument can specify the environment in which to look for the object in any of several ways: as a positive integer (the position in the search list); as the character string name of an element in the search list; or as an environment (including using sys.frame to access the currently active function calls). The default of -1 indicates the current environment of the call to get. The envir argument is an alternative way to specify an environment. These functions look to see if each of the name(s) x have a value bound to it in the specified environment. If inherits is TRUE and a value is not found for x in the specified environment, the enclosing frames of the environment are searched until the name x is encountered. See environment and the ‘R Language Definition’ manual for details a

Examples

Example
R 
# NOT RUN {
get("%o%")

## test mget
e1 <- new.env()
mget(letters, e1, ifnotfound = as.list(LETTERS))
# }

See Also

exists for checking whether an object exists; get0 for an efficient way of both checking existence and getting an object. assign the inverse of get() see above. Use getAnywhere for searching for an object anywhere including in other namespaces and getFromNamespace to find an object in a specific namespace.