add slicing characteristic

adjust vignette to qenv details

Author: gogonzo

R/qenv-constructor.R

@@ -13,6 +13,7 @@
 #' - `qenv` is a locked environment, and data modification is only possible through the [eval_code()]
 #'   and [within.qenv()] functions.
 #' - It stores metadata about the code used to create the data (see [get_code()]).
+#' - It supports slicing (see [`subset-qenv`])
 #' - Is immutable which means that each code evaluation does not modify the original `qenv`
 #'   environment directly. See the following code:
 #'

R/qenv-extract.R

@@ -1,4 +1,4 @@
-#' Subset `qenv`
+#' Subsets `qenv`
 #'
 #' @description
 #' Subsets [`qenv`] environment and limits the code to the necessary needed to build limited objects.
@@ -8,7 +8,7 @@
 #' are skipped.
 #' @param ... internal usage, please ignore.
 #'
-#' @name extract-qenv
+#' @name subset-qenv
 #'
 #' @examples
 #' q <- qenv()

_pkgdown.yml

@@ -26,7 +26,6 @@ reference:
   - title: "Reproducible qenv objects"
     desc: "methods to get and modify values of qenv objects"
     contents:
-      - extract-qenv
       - concat
       - dev_suppress
       - eval_code
@@ -38,4 +37,5 @@ reference:
       - join
       - qenv
       - show,qenv-method
+      - subset-qenv
       - within.qenv

man/qenv.Rd

@@ -12,9 +12,11 @@ vignette: >
 
 A `qenv` inherits from the `environment` class, behaves like an environment, and has the following characteristics:
 
--	The environment is locked, and data modification is only possible through the `eval_code()` and `within()` functions.
-- It stores metadata about the code used to create the data.
-- Is immutable which means that each code evaluation does not modify the original `qenv` object directly. 
+- It inherits from the environment and methods such as `$`, `get`, `ls`, `as.list()` work out of the box.
+- `qenv` is a locked environment, and data modification is only possible through the `eval_code` and `within` functions.
+- It stores metadata about the code used to create the data (see `get_code`).
+- It supports slicing by `[`.
+- Is immutable which means that each code evaluation does not modify the original `qenv` environment directly.
 
 ### Initialization