File: env-and-data.R

package info (click to toggle)
r-cran-igraph 2.1.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 27,044 kB
  • sloc: ansic: 204,981; cpp: 21,711; fortran: 4,090; yacc: 1,229; lex: 519; sh: 52; makefile: 8
file content (38 lines) | stat: -rw-r--r-- 1,282 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#' `.data` and `.env` pronouns
#'
#' @description
#'
#' The `.data` and `.env` pronouns make it explicit where to look up attribute
#' names when indexing `V(g)` or `E(g)`, i.e. the vertex or edge sequence of a
#' graph. These pronouns are inspired by `.data` and `.env` in `rlang` - thanks
#' to MichaƂ Bojanowski for bringing these to our attention.
#'
#' The rules are simple:
#'
#' * `.data` retrieves attributes from the graph whose vertex or edge sequence
#'   is being evaluated.
#' * `.env` retrieves variables from the calling environment.
#'
#' Note that `.data` and `.env` are injected dynamically into the environment
#' where the indexing expressions are evaluated; you cannot get access to these
#' objects outside the context of an indexing expression. To avoid warnings
#' printed by `R CMD check` when code containing `.data` and `.env` is checked,
#' you can import `.data` and `.env` from `igraph` if needed. Alternatively,
#' you can declare them explicitly with `utils::globalVariables()` to silence
#' the warnings.
#'
#' @name dot-data
#' @aliases dot-env
#' @format NULL
#' @usage NULL
#' @family env-and-data
#' @export
#' @md
.data <- rlang::.data

#' @rdname dot-data
#' @format NULL
#' @usage NULL
#' @family env-and-data
#' @export
.env <- rlang::.env