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

[Up] [Top]

Documentation for package ‘rlang’ version 1.1.3

Help Pages

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

-- A --

abort Signal an error, warning, or message
add_backtrace Display backtrace on error
args_error_context Documentation anchor for error arguments
arg_match Match an argument to a character vector
arg_match0 Match an argument to a character vector
as_box Convert object to a box
as_box_if Convert object to a box
as_bytes Human readable memory sizes
as_data_mask Create a data mask
as_data_pronoun Create a data mask
as_environment Coerce to an environment
as_function Convert to function
as_label Create a default name for an R object
as_name Extract names from symbols
as_quosure Create a quosure from components
as_quosures Create a list of quosures
as_string Cast symbol to string

-- B --

bang-bang Injection operator !!
bare-type-predicates Bare type predicates
box Box a value
bytes Create vectors
bytes-class Human readable memory sizes

-- C --

call2 Create a call
caller_arg Find the caller argument for error messages
caller_call Get properties of the current or caller frame
caller_env Get properties of the current or caller frame
caller_fn Get properties of the current or caller frame
call_args Extract arguments from a call
call_args_names Extract arguments from a call
call_inspect Inspect a call
call_match Match supplied arguments to function definition
call_modify Modify the arguments of a call
call_name Extract function name or namespace of a call
call_ns Extract function name or namespace of a call
catch_cnd Catch a condition
check_dots_empty Check that dots are empty
check_dots_unnamed Check that all dots are unnamed
check_dots_used Check that all dots have been used
check_exclusive Check that arguments are mutually exclusive
check_installed Are packages installed in any of the libraries?
check_required Check that argument is supplied
chr Create vectors
cnd_body Build an error message from parts
cnd_footer Build an error message from parts
cnd_header Build an error message from parts
cnd_inherits Does a condition or its ancestors inherit from a class?
cnd_message Build an error message from parts
cnd_signal Signal a condition object
cpl Create vectors
curly-curly Embrace operator {{
current_call Get properties of the current or caller frame
current_env Get properties of the current or caller frame
current_fn Get properties of the current or caller frame

-- D --

data_sym Create a symbol or list of symbols
data_syms Create a symbol or list of symbols
dbl Create vectors
doc_dots_dynamic Dynamic dots features
done Box a final value for early termination
dot-data '.data' and '.env' pronouns
dots_list Collect dynamic dots in a list
dyn-dots Dynamic dots features

-- E --

embrace-operator Embrace operator {{
empty_env Get the empty environment
englue Defuse function arguments with glue
enquo Defuse function arguments
enquos Defuse function arguments
env Create a new environment
env_bind Bind symbols to objects in an environment
env_bind_active Bind symbols to objects in an environment
env_bind_lazy Bind symbols to objects in an environment
env_browse Browse environments
env_cache Cache a value in an environment
env_clone Clone or coalesce an environment
env_coalesce Clone or coalesce an environment
env_depth Depth of an environment chain
env_get Get an object in an environment
env_get_list Get an object in an environment
env_has Does an environment have or see bindings?
env_inherits Does environment inherit from another environment?
env_is_browsed Browse environments
env_is_user_facing Is frame environment user facing?
env_label Label of an environment
env_length Names and numbers of symbols bound in an environment
env_name Label of an environment
env_names Names and numbers of symbols bound in an environment
env_parent Get parent environments
env_parents Get parent environments
env_poke Poke an object in an environment
env_poke_parent Get or set the environment of an object
env_print Pretty-print an environment
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 with quosures and pronoun support
exec Execute a function
expr Defuse an R expression
exprs_auto_name Ensure that all elements of a list of expressions are named
expr_deparse Print an expression
expr_print Print an expression

-- F --

faq-options Global options for rlang
fn_body Get or set function body
fn_body<- Get or set function body
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<- Extract arguments from a function
fn_fmls_names Extract arguments from a function
fn_fmls_names<- Extract arguments from a function
fn_fmls_syms Extract arguments from a function
format_error_bullets Format bullets for error messages
frame_call Get properties of the current or caller frame
frame_fn Get properties of the current or caller frame
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
global_entrace Entrace unexpected errors
global_handle Register default global handlers
global_prompt_install Prompt user to install missing packages
glue-operators Name injection with '"{"' and '"{{"'

-- H --

hash Hashing
hash_file Hashing
has_name Does an object have an element with this name?
have_name Is object named?

-- I --

inform Signal an error, warning, or message
inherits_all Does an object inherit from a set of classes?
inherits_any Does an object inherit from a set of classes?
inherits_only Does an object inherit from a set of classes?
inject Inject objects in an R expression
injection-operator Injection operator !!
int Create vectors
is_atomic Type predicates
is_bare_atomic Bare type predicates
is_bare_bytes Bare type predicates
is_bare_character Bare type predicates
is_bare_complex Bare type predicates
is_bare_double Bare type predicates
is_bare_environment 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_bool Scalar type predicates
is_box Box a value
is_bytes Type predicates
is_call Is object a call?
is_call_simple Extract function name or namespace of a call
is_character Type predicates
is_closure Is object a function?
is_complex Type predicates
is_done_box Box a final value for early termination
is_double Type predicates
is_empty Is object an empty vector or NULL?
is_environment Is object an environment?
is_expression Is an object an expression?
is_false Is object identical to TRUE or FALSE?
is_formula Is object a formula?
is_function Is object a function?
is_installed Are packages installed in any of the libraries?
is_integer Type predicates
is_integerish Is a vector integer-like?
is_interactive Is R running interactively?
is_lambda Convert to function
is_list Type predicates
is_logical Type predicates
is_missing Generate or handle a missing argument
is_named Is object named?
is_named2 Is object named?
is_namespace Is an object a namespace environment?
is_null Type predicates
is_primitive Is object a function?
is_primitive_eager Is object a function?
is_primitive_lazy Is object a function?
is_quosure Create a quosure from components
is_quosures Create a list of quosures
is_raw Type predicates
is_scalar_atomic Scalar type predicates
is_scalar_bytes Scalar type predicates
is_scalar_character Scalar type predicates
is_scalar_complex 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_spliced Splice values at dots collection time
is_spliced_bare Splice values at dots collection time
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_vector Type predicates
is_weakref Is object a weak reference?
is_zap Create zap objects

-- L --

last_error Last 'abort()' error
last_messages Display last messages and warnings
last_trace Last 'abort()' error
last_warnings Display last messages and warnings
lgl Create vectors
list2 Collect dynamic dots in a list
ll Collect dynamic dots in a list
local_bindings Temporarily change bindings of an environment
local_error_call Set local error call in an execution environment
local_interactive Is R running interactively?
local_options Change global options

-- M --

maybe_missing Generate or handle a missing argument
missing_arg Generate or handle a missing argument

-- N --

names2 Get names of a vector
names2<- Get names of a vector
new_box Box a value
new_data_mask Create a data mask
new_environment Create a new environment
new_formula Create a formula
new_function Create a function
new_quosure Create a quosure from components
new_quosures Create a list of quosures
new_weakref Create a weak reference

-- O --

on_load Run expressions on load
on_package_load Run expressions on load
op-get-attr Infix attribute accessor and setter
op-null-default Default value for 'NULL'

-- P --

pairlist2 Collect dynamic dots in a pairlist
parse_bytes Human readable memory sizes
parse_expr Parse R code
parse_exprs Parse R code
parse_quo Parse R code
parse_quos Parse R code
peek_option Change global options
peek_options Change global options
push_options Change global options

-- Q --

qq_show Show injected expression
quosure Quosure getters, setters and predicates
quosure-tools Quosure getters, setters and predicates
quos_auto_name Ensure that all elements of a list of expressions are named
quo_get_env Quosure getters, setters and predicates
quo_get_expr Quosure getters, setters and predicates
quo_is_call Quosure getters, setters and predicates
quo_is_missing Quosure getters, setters and predicates
quo_is_null Quosure getters, setters and predicates
quo_is_symbol Quosure getters, setters and predicates
quo_is_symbolic Quosure getters, setters and predicates
quo_set_env Quosure getters, setters and predicates
quo_set_expr Quosure getters, setters and predicates
quo_squash Squash a quosure

-- R --

rep_along Create vectors matching the length of a given vector
rep_named Create vectors matching the length of a given vector
reset_message_verbosity Signal an error, warning, or message
reset_warning_verbosity Signal an error, warning, or message
rlang_backtrace_on_error Display backtrace on error
rlang_backtrace_on_error_report Display backtrace on error
rlang_backtrace_on_warning_report Display backtrace on error
rlang_error Errors of class 'rlang_error'
run_on_load Run expressions on load

-- S --

scalar-type-predicates Scalar type predicates
seq2 Increasing sequence of integers in an interval
seq2_along Increasing sequence of integers in an interval
set_env Get or set the environment of an object
set_names Set names of a vector
signal Signal an error, warning, or message
splice Splice values at dots collection time
splice-operator Splice operator !!!
stack Get properties of the current or caller frame
sym Create a symbol or list of symbols
syms Create a symbol or list of symbols

-- T --

tidy-dots Dynamic dots features
tidyeval-data '.data' and '.env' pronouns
trace_back Capture a backtrace
trace_length Capture a backtrace
try_fetch Try an expression with condition handlers
type-predicates Type predicates

-- U --

unbox Box a value

-- V --

vector-construction Create vectors

-- W --

warn Signal an error, warning, or message
with_bindings Temporarily change bindings of an environment
with_interactive Is R running interactively?
with_options Change global options
wref_key Get key/value from a weak reference object
wref_value Get key/value from a weak reference object

-- Z --

zap Create zap objects
zap_srcref Zap source references

-- misc --

!! Injection operator !!
!!! Splice operator !!!
%<~% Bind symbols to objects in an environment
%@% Infix attribute accessor and setter
%@%<- Infix attribute accessor and setter
%||% Default value for 'NULL'
.data '.data' and '.env' pronouns
.env '.data' and '.env' pronouns
:= Dynamic dots features