search: Search up the full scope for functions

In reproducible: Enhance Reproducibility of R Code

Search up the full scope for functions

Description

This is like base::search but when used inside a function, it will show the full scope (see figure in the section Binding environments on http://adv-r.had.co.nz/Environments.html). This full search path will be potentially much longer than just search() (which always starts at .GlobalEnv).

searchFullEx shows an example function that is inside this package whose only function is to show the Scope of a package function.

Usage

searchFull(env = parent.frame(), simplify = TRUE)

searchFullEx()

Arguments

env	The environment to start searching at. Default is calling environment, i.e., parent.frame()
simplify	Logical. Should the output be simplified to character, if possible (usually it is not possible because environments don't always coerce correctly)

Details

searchFullEx can be used to show an example of the use of searchFull.

Value

A list of environments that is the actual search path, unlike search() which only prints from .GlobalEnv up to base through user attached packages.

See Also

base::search()

Examples

seeScope <- function() {
  searchFull()
}
seeScope()
searchFull()
searchFullEx()

reproducible documentation built on Nov. 22, 2023, 9:06 a.m.