R: Functions for Base Types and Core R and 'Tidyverse' Features

# Functions for Base Types and Core R and 'Tidyverse' Features

## Documentation for package ‘rlang’ version 0.1.6

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A B C D E F G H I L M N O P Q R S T U V W misc

## -- A --

abort | Signal an error, warning, or message
are_na | Test for missing values
arg_match | Match an argument to a character vector
as_bytes | Coerce to a raw vector
as_character | Coerce an object to a base type
as_closure | Convert to function or closure
as_complex | Coerce an object to a base type
as_dictionary | Create a dictionary
as_double | Coerce an object to a base type
as_env | Coerce to an environment
as_function | Convert to function or closure
as_integer | Coerce an object to a base type
as_list | Coerce an object to a base type
as_logical | Coerce an object to a base type
as_native_character | Coerce to a character vector and attempt encoding conversion
as_native_string | Coerce to a character vector and attempt encoding conversion
as_overscope | Create a dynamic scope for tidy evaluation
as_pairlist | Coerce to pairlist
as_quosure | Coerce object to quosure
as_quosureish | Coerce object to quosure
as_string | Coerce an object to a base type
as_utf8_character | Coerce to a character vector and attempt encoding conversion
as_utf8_string | Coerce to a character vector and attempt encoding conversion

## -- B --

bare-type-predicates | Bare type predicates
base_env | Scoped environments
bytes | Create vectors
bytes_along | Create vectors matching the length of a given vector
bytes_len | Create vectors matching a given length

## -- C --

caller_env | Get the environment of the caller frame
caller_fn | Get the environment of the caller frame
caller_frame | Get the environment of the caller frame
call_depth | Call stack information
call_frame | Call stack information
call_inspect | Inspect a call
call_stack | Call stack information
child_env | Create a new environment
chr | Create vectors
chr_along | Create vectors matching the length of a given vector
chr_encoding | Set encoding of a string or character vector
chr_len | Create vectors matching a given length
cnd_abort | Signal a condition
cnd_error | Create a condition object
cnd_message | Create a condition object
cnd_signal | Signal a condition
cnd_warning | Create a condition object
coerce_class | Dispatch on base types
coerce_lang | Dispatch on call type
coerce_type | Dispatch on base types
cpl | Create vectors
cpl_along | Create vectors matching the length of a given vector
cpl_len | Create vectors matching a given length
ctxt_depth | Call stack information
ctxt_frame | Call stack information
ctxt_stack | Call stack information
current_frame | Call stack information

## -- D --

dbl | Create vectors
dbl_along | Create vectors matching the length of a given vector
dbl_len | Create vectors matching a given length
dictionary | Create a dictionary
dots_definitions | Tidy quotation of multiple expressions and dots
dots_list | Extract dots with splicing semantics
dots_n | How many arguments are currently forwarded in dots?
dots_splice | Extract dots with splicing semantics
dots_values | Evaluate dots with preliminary splicing
duplicate | Duplicate an R object

## -- E --

empty_env | Get the empty environment
enexpr | Raw quotation of an expression
enquo | Create quosures
env | Create a new environment
env_bind | Bind symbols to objects in an environment
env_bind_exprs | Bind symbols to objects in an environment
env_bind_fns | Bind symbols to objects in an environment
env_bury | Overscope bindings by defining symbols deeper in a scope
env_clone | Clone an environment
env_depth | Depth of an environment chain
env_get | Get an object from an environment
env_has | Does an environment have or see bindings?
env_inherits | Does environment inherit from another environment?
env_names | Names of symbols bound in an environment
env_parent | Get parent environments
env_parents | Get parent environments
env_tail | Get parent environments
env_unbind | Remove bindings from an environment
eval_bare | Evaluate an expression in an environment
eval_tidy | Evaluate an expression tidily
eval_tidy_ | Tidy evaluation in a custom environment
exiting | Create an exiting or in place handler
expr | Raw quotation of an expression
exprs | Raw quotation of an expression
exprs_auto_name | Ensure that list of expressions are all named
expr_interp | Process unquote operators in a captured expression
expr_label | Turn an expression to a label
expr_name | Turn an expression to a label
expr_text | Turn an expression to a label

## -- F --

flatten | Flatten or squash a list of lists into a simpler vector
flatten_chr | Flatten or squash a list of lists into a simpler vector
flatten_cpl | Flatten or squash a list of lists into a simpler vector
flatten_dbl | Flatten or squash a list of lists into a simpler vector
flatten_if | Flatten or squash a list of lists into a simpler vector
flatten_int | Flatten or squash a list of lists into a simpler vector
flatten_lgl | Flatten or squash a list of lists into a simpler vector
flatten_raw | Flatten or squash a list of lists into a simpler vector
fn_env | Return the closure environment of a function
fn_env<- | Return the closure environment of a function
fn_fmls | Extract arguments from a function
fn_fmls_names | Extract arguments from a function
fn_fmls_syms | Extract arguments from a function
frame_position | Find the position or distance of a frame on the evaluation stack
friendly_type | Format a type for error messages
f_env | Get or set formula components
f_env<- | Get or set formula components
f_label | Turn RHS of formula into a string or label
f_lhs | Get or set formula components
f_lhs<- | Get or set formula components
f_name | Turn RHS of formula into a string or label
f_rhs | Get or set formula components
f_rhs<- | Get or set formula components
f_text | Turn RHS of formula into a string or label

## -- G --

get_env | Get or set the environment of an object
get_expr | Set and get an expression
global_env | Scoped environments
global_frame | Call stack information

## -- H --

has_length | How long is an object?
has_name | Does an object have an element with this name?
have_name | Is object named?

## -- I --

inform | Signal an error, warning, or message
inplace | Create an exiting or in place handler
int | Create vectors
int_along | Create vectors matching the length of a given vector
int_len | Create vectors matching a given length
invoke | Invoke a function with a list of arguments
is_atomic | Type predicates
is_bare_atomic | Bare type predicates
is_bare_bytes | Bare type predicates
is_bare_character | Bare type predicates
is_bare_double | Bare type predicates
is_bare_env | Is object an environment?
is_bare_formula | Is object a formula?
is_bare_integer | Bare type predicates
is_bare_integerish | Is a vector integer-like?
is_bare_list | Bare type predicates
is_bare_logical | Bare type predicates
is_bare_numeric | Bare type predicates
is_bare_raw | Bare type predicates
is_bare_string | Bare type predicates
is_bare_vector | Bare type predicates
is_binary_lang | Is object a call?
is_bytes | Type predicates
is_callable | Is an object callable?
is_call_stack | Is object a stack?
is_character | Type predicates
is_chr_na | Test for missing values
is_closure | Is object a function?
is_condition | Is object a condition?
is_copyable | Is an object copyable?
is_cpl_na | Test for missing values
is_dbl_na | Test for missing values
is_definition | Definition operator
is_dictionary | Create a dictionary
is_dictionaryish | Is object named?
is_double | Type predicates
is_empty | Is object an empty vector or NULL?
is_env | Is object an environment?
is_eval_stack | Is object a stack?
is_expr | Is an object an expression?
is_false | Is object identical to TRUE or FALSE?
is_formula | Is object a formula?
is_formulaish | Is object a formula?
is_frame | Is object a frame?
is_function | Is object a function?
is_installed | Is a package installed in the library?
is_integer | Type predicates
is_integerish | Is a vector integer-like?
is_int_na | Test for missing values
is_lang | Is object a call?
is_lgl_na | Test for missing values
is_list | Type predicates
is_logical | Type predicates
is_missing | Generate or handle a missing argument
is_na | Test for missing values
is_named | Is object named?
is_node | Is object a node or pairlist?
is_null | Type predicates
is_pairlist | Is object a node or pairlist?
is_primitive | Is object a function?
is_primitive_eager | Is object a function?
is_primitive_lazy | Is object a function?
is_quosure | Is an object a quosure or quosure-like?
is_quosureish | Is an object a quosure or quosure-like?
is_quosures | Tidy quotation of multiple expressions and dots
is_raw | Type predicates
is_reference | Is an object referencing another?
is_scalar_atomic | Scalar type predicates
is_scalar_bytes | Scalar type predicates
is_scalar_character | Scalar type predicates
is_scalar_double | Scalar type predicates
is_scalar_integer | Scalar type predicates
is_scalar_integerish | Is a vector integer-like?
is_scalar_list | Scalar type predicates
is_scalar_logical | Scalar type predicates
is_scalar_raw | Scalar type predicates
is_scalar_vector | Scalar type predicates
is_scoped | Scoped environments
is_spliced | Splice a list within a vector
is_spliced_bare | Splice a list within a vector
is_stack | Is object a stack?
is_string | Scalar type predicates
is_symbol | Is object a symbol?
is_symbolic | Is an object an expression?
is_syntactic_literal | Is an object an expression?
is_true | Is object identical to TRUE or FALSE?
is_unary_lang | Is object a call?
is_vector | Type predicates

## -- L --

lang | Create a call
lang_args | Extract arguments from a call
lang_args_names | Extract arguments from a call
lang_fn | Extract function from a call
lang_head | Return the head or tail of a call object
lang_modify | Modify the arguments of a call
lang_name | Extract function name of a call
lang_standardise | Standardise a call
lang_tail | Return the head or tail of a call object
lang_type_of | Dispatch on call type
lgl | Create vectors
lgl_along | Create vectors matching the length of a given vector
lgl_len | Create vectors matching a given length
list_along | Create vectors matching the length of a given vector
list_len | Create vectors matching a given length
ll | Create vectors
locally | Evaluate an expression within a given environment

## -- M --

maybe_missing | Generate or handle a missing argument
missing | Missing values
missing_arg | Generate or handle a missing argument
modify | Modify a vector
mut_attrs | Add attributes to an object
mut_latin1_locale | Set the locale's codeset for testing
mut_mbcs_locale | Set the locale's codeset for testing
mut_node_caar | Helpers for pairlist and language nodes
mut_node_cadr | Helpers for pairlist and language nodes
mut_node_car | Helpers for pairlist and language nodes
mut_node_cdar | Helpers for pairlist and language nodes
mut_node_cddr | Helpers for pairlist and language nodes
mut_node_cdr | Helpers for pairlist and language nodes
mut_node_tag | Helpers for pairlist and language nodes
mut_utf8_locale | Set the locale's codeset for testing

## -- N --

names2 | Get names of a vector
na_chr | Missing values
na_cpl | Missing values
na_dbl | Missing values
na_int | Missing values
na_lgl | Missing values
new_cnd | Create a condition object
new_definition | Definition operator
new_environment | Create a new environment
new_formula | Create a formula
new_function | Create a function
new_language | Create a call
new_overscope | Create a dynamic scope for tidy evaluation
new_quosure | Create quosures
node | Helpers for pairlist and language nodes
node_caar | Helpers for pairlist and language nodes
node_cadr | Helpers for pairlist and language nodes
node_car | Helpers for pairlist and language nodes
node_cdar | Helpers for pairlist and language nodes
node_cddr | Helpers for pairlist and language nodes
node_cdr | Helpers for pairlist and language nodes
node_tag | Helpers for pairlist and language nodes
ns_env | Get the namespace of a package
ns_env_name | Get the namespace of a package
ns_imports_env | Get the namespace of a package

## -- O --

op-definition | Definition operator
op-get-attr | Infix attribute accessor
op-na-default | Replace missing values
op-null-default | Default value for 'NULL'
overscope_clean | Create a dynamic scope for tidy evaluation
overscope_eval_next | Create a dynamic scope for tidy evaluation

## -- P --

pairlist | Helpers for pairlist and language nodes
parse_expr | Parse R code
parse_exprs | Parse R code
parse_quosure | Parse R code
parse_quosures | Parse R code
pkg_env | Scoped environments
pkg_env_name | Scoped environments
prepend | Prepend a vector
prim_name | Name of a primitive function

## -- Q --

quasiquotation | Quasiquotation of an expression
quo | Create quosures
quo-predicates | Is a quosure quoting a symbolic, missing or NULL object?
quos | Tidy quotation of multiple expressions and dots
quosure | Create quosures
quosures | Tidy quotation of multiple expressions and dots
quos_auto_name | Ensure that list of expressions are all named
quo_expr | Splice a quosure and format it into string or label
quo_is_lang | Is a quosure quoting a symbolic, missing or NULL object?
quo_is_missing | Is a quosure quoting a symbolic, missing or NULL object?
quo_is_null | Is a quosure quoting a symbolic, missing or NULL object?
quo_is_symbol | Is a quosure quoting a symbolic, missing or NULL object?
quo_is_symbolic | Is a quosure quoting a symbolic, missing or NULL object?
quo_label | Splice a quosure and format it into string or label
quo_name | Splice a quosure and format it into string or label
quo_text | Splice a quosure and format it into string or label

## -- R --

raw_along | Create vectors matching the length of a given vector
raw_len | Create vectors matching a given length
rep_along | Create vectors matching the length of a given vector
restarting | Create a restarting handler
return_from | Jump to or from a frame
return_to | Jump to or from a frame
rst_abort | Jump to the abort restart
rst_exists | Restarts utilities
rst_jump | Restarts utilities
rst_list | Restarts utilities
rst_maybe_jump | Restarts utilities
rst_muffle | Jump to a muffling restart

## -- S --

scalar-type-predicates | Scalar type predicates
scoped_env | Scoped environments
scoped_envs | Scoped environments
scoped_names | Scoped environments
seq2 | Increasing sequence of integers in an interval
seq2_along | Increasing sequence of integers in an interval
set_attrs | Add attributes to an object
set_chr_encoding | Set encoding of a string or character vector
set_env | Get or set the environment of an object
set_expr | Set and get an expression
set_names | Set names of a vector
set_str_encoding | Set encoding of a string or character vector
splice | Splice a list within a vector
squash | Flatten or squash a list of lists into a simpler vector
squash_chr | Flatten or squash a list of lists into a simpler vector
squash_cpl | Flatten or squash a list of lists into a simpler vector
squash_dbl | Flatten or squash a list of lists into a simpler vector
squash_if | Flatten or squash a list of lists into a simpler vector
squash_int | Flatten or squash a list of lists into a simpler vector
squash_lgl | Flatten or squash a list of lists into a simpler vector
squash_raw | Flatten or squash a list of lists into a simpler vector
stack | Call stack information
stack_trim | Trim top call layers from the evaluation stack
string | Create a string
str_encoding | Set encoding of a string or character vector
switch_class | Dispatch on base types
switch_lang | Dispatch on call type
switch_type | Dispatch on base types
sym | Create a symbol or list of symbols
syms | Create a symbol or list of symbols

## -- T --

tidyeval-data | Data pronoun for tidy evaluation
type-predicates | Type predicates
type_of | Base type of an object

## -- U --

UQ | Quasiquotation of an expression
UQE | Quasiquotation of an expression
UQS | Quasiquotation of an expression

## -- V --

vector-along | Create vectors matching the length of a given vector
vector-coercion | Coerce an object to a base type
vector-construction | Create vectors
vector-len | Create vectors matching a given length

## -- W --

warn | Signal an error, warning, or message
with_env | Evaluate an expression within a given environment
with_handlers | Establish handlers on the stack
with_restarts | Establish a restart point on the stack

## -- misc --

!! | Quasiquotation of an expression
!!! | Quasiquotation of an expression
%@% | Infix attribute accessor
%|% | Replace missing values
%||% | Default value for 'NULL'
.data | Data pronoun for tidy evaluation
:= | Definition operator