127 introduce within.qenv

[chlebowa]

Closes #127

Added an S3 within method for class qenv which is a wrapper for eval_code.

Usage: within(data, expr, ...)

within.qenv is created for convenience and accepts only inline expressions, not language or character variables, nor literal strings.

The ... argument can be used to inject values into expr before evaluation.

EXAMPLES

Evaluate simple or compound expressions in qenv.

q <- new_qenv()
q <- within(q, i <- iris)
q <- within(q, {
  m <- mtcars
  f <- faithful
})
q
within(q, dim(f))

Inject value into expr.

qq <- within(q, ii <- subset(i, Species == species), species = "virginica")
within(qq, print(summary(ii)))

Inject value with variable.

input_value <- "versicolor"
qq <- within(q, ii <- subset(i, Species == species), species = input_value)
within(qq, print(summary(ii)))

[github-actions]

Code Coverage Summary

Filename                 Stmts    Miss  Cover    Missing
---------------------  -------  ------  -------  ---------
R/include_css_js.R           7       7  0.00%    12-20
R/qenv-concat.R             10       0  100.00%
R/qenv-constructor.R        12       0  100.00%
R/qenv-eval_code.R          48       2  95.83%   91, 100
R/qenv-get_code.R           18       0  100.00%
R/qenv-get_var.R            19       0  100.00%
R/qenv-get_warnings.R       24       0  100.00%
R/qenv-join.R               46       0  100.00%
R/qenv-show.R                1       1  0.00%    16
R/qenv-within.R              7       0  100.00%
R/utils.R                   19       0  100.00%
TOTAL                      211      10  95.26%

Diff against main

Filename           Stmts    Miss  Cover
---------------  -------  ------  --------
R/qenv-within.R       +7       0  +100.00%
TOTAL                 +7       0  +0.16%

Results for commit: eea0513

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

    1 files      9 suites   1s ⏱️
  72 tests   72 ✔️ 0 💤 0 ❌
157 runs  157 ✔️ 0 💤 0 ❌

Results for commit eea0513.

♻️ This comment has been updated with latest results.

[chlebowa]

@gogonzo In the current form within cannot accept language objects or lists of language objects. If one really wants to squeeze an expression there, one can use do.call.

# single expression
expr <- expression(i <- iris, m <- mtcars)
do.call(within, list(q, expr))

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

(Calls and call lists will not work, it has to be a single expression.)

The problem(?) is substitution is not available in these cases. The question is: do we care? Because I can make it work but then within itself will be open for directly passing expressions (possibly calls as well). I guess a use case would be something like what happens in tmc, where a module builds up a list of expressions and pushes them into a qenv all at once, but then the expressions are already properly substituted. On the other hand, the substitutions have to be done for each expression separately, whereas with this we could have them all done in one place, which would be neat, wouldn't it?

[gogonzo]

I think that warning is not needed for single symbol

[gogonzo]

Please try to write tests with single expectation and precise description.

[gogonzo]

We got it! 🔥 🔥 🔥

[m7pr]

respect