Skip to content

Commit e90d07b

Browse files
committed
qenv characteristics
1 parent 9bb5da1 commit e90d07b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

vignettes/qenv.Rmd

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@ vignette: >
1010

1111
## Introduction to `qenv`
1212

13-
A `qenv` is an `environment` which contains data and a code used to create data.
13+
A `qenv` object inherits from the `environment` class, behaves like an environment, and has the following characteristics:
14+
15+
- The environment is locked, and data modification is only possible through the `eval_code()` and `within()` functions.
16+
- It stores metadata about the code used to create the data.
17+
- Is immutable which means that each code evaluation does not modify the original `qenv` object directly.
1418

1519
### Initialization
1620

@@ -26,8 +30,7 @@ print(empty_qenv)
2630

2731
### `qenv` basic usage
2832

29-
`qenv` object is a locked `environment`. To modify the data use `eval_code` to execute R code
30-
within the environment, yielding a new `qenv` object as the output.
33+
To modify the data use `eval_code` to execute R code within the environment, yielding a new `qenv` object as the output.
3134

3235
```{r}
3336
# evaluate code in qenv

0 commit comments

Comments
 (0)