Skip to content

Commit

Permalink
Slightly clearer description in new_data_mask()
Browse files Browse the repository at this point in the history
  • Loading branch information
lionel- committed Oct 24, 2024
1 parent 69659c4 commit 1a6a993
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 18 deletions.
19 changes: 10 additions & 9 deletions R/eval-tidy.R
Original file line number Diff line number Diff line change
Expand Up @@ -220,15 +220,16 @@ print.rlang_fake_data_pronoun <- function(...) cat_line("<pronoun>")
#' @description
#'
#' A [data mask][topic-data-mask] is an environment (or possibly
#' multiple environments forming an ancestry) containing user-supplied
#' objects. Objects in the mask have precedence over objects in the
#' environment (i.e. they mask those objects). Many R functions
#' evaluate quoted expressions in a data mask so these expressions can
#' refer to objects within the user data.
#'
#' These functions let you construct a tidy eval data mask manually.
#' They are meant for developers of tidy eval interfaces rather than
#' for end users.
#' multiple environments forming an ancestry) that inherits from the
#' current evaluation environment and contains additional named objects.
#' These extra variables are added to the evaluation context and, if there
#' are any name clashes, have precedence over the latter (i.e., they mask
#' those objects). Data masks are the technique by which columns of a data
#' frame are made available in special evaluation contexts such as
#' `dplyr::summarise()`.
#'
#' These functions build a tidy eval data mask manually. They are meant
#' for developers of tidy eval interfaces rather than for end users.
#'
#'
#' @section Why build a data mask?:
Expand Down
19 changes: 10 additions & 9 deletions man/as_data_mask.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 1a6a993

Please sign in to comment.