within.qenv: Evaluate code in 'qenv'

View source: R/qenv-within.R

within.qenvR Documentation

Evaluate code in qenv

Description

Evaluate code in qenv

Usage

## S3 method for class 'qenv'
within(data, expr, ...)

Arguments

data

(qenv)

expr

(expression) to evaluate. Must be inline code, see ⁠Using language objects...⁠

...

named argument value will substitute a symbol in the expr matched by the name. For practical usage see Examples section below.

Details

within() is a convenience method that wraps eval_code to provide a simplified way of passing expression. within accepts only inline expressions (both simple and compound) and allows to substitute expr with ... named argument values.

Using language objects with within

Passing language objects to expr is generally not intended but can be achieved with do.call. Only single expressions will work and substitution is not available. See examples.

Examples

# evaluate code using within
q <- qenv()
q <- within(q, {
  i <- iris
})
q <- within(q, {
  m <- mtcars
  f <- faithful
})
q
get_code(q)

# inject values into code
q <- qenv()
q <- within(q, i <- iris)
within(q, print(dim(subset(i, Species == "virginica"))))
within(q, print(dim(subset(i, Species == species)))) # fails
within(q, print(dim(subset(i, Species == species))), species = "versicolor")
species_external <- "versicolor"
within(q, print(dim(subset(i, Species == species))), species = species_external)

# pass language objects
expr <- expression(i <- iris, m <- mtcars)
within(q, expr) # fails
do.call(within, list(q, expr))

exprlist <- list(expression(i <- iris), expression(m <- mtcars))
within(q, exprlist) # fails
do.call(within, list(q, do.call(c, exprlist)))


teal.code documentation built on Aug. 19, 2025, 1:14 a.m.