Learn R Programming

rlang

rlang is a collection of frameworks and APIs for programming with R.

Frameworks

Two comprehensive frameworks are implemented in rlang.

  • tidy eval, a programmable data-masking framework used in tidyverse packages like dplyr and ggplot2. As a user, you will encounter the embracing operator {{ and name injection with the glue operators "{" and "{{".

  • rlang errors, a set of tools to signal and display errors. This includes backtrace capture with global_entrace() and backtrace display with last_error() and last_warnings(). Use abort() to create errors with bullet lists, structured metadata, and error chaining support.

    The display of error messages is optimised for bullet lists and chained errors and optionally integrates with the cli package (see local_use_cli()).

Argument intake

A set of tools help you check, validate, and preprocess arguments.

  • Checking function arguments, e.g. arg_match(), check_required(), and check_exclusive().

  • Checking dots, e.g. check_dots_used() and check_dots_empty().

  • Collecting dynamic dots, e.g. list2(). These dots support splicing with !!! and name injection with the glue operators "{" and "{{".

Programming interfaces

rlang provides various interfaces for working with R and R objects.

  • The R session, e.g. check_installed(), on_load(), and on_package_load().

  • Environments, e.g. env(), env_has(), env_get(), env_bind(), env_unbind(), env_print(), and local_bindings().

  • Evaluation, e.g. inject() and eval_bare().

  • Calls and symbols, e.g. call2(), is_call(), is_call_simple(), data_sym(), and data_syms().

  • Functions, e.g. new_function() and as_function(). The latter supports the purrr-style formula notation for lambda functions.

Installation

Install the released version of rlang from CRAN:

install.packages("rlang")

Or install the development version from GitHub with:

# install.packages("pak")
pak::pkg_install("r-lib/rlang")

Code of Conduct

Please note that the rlang project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Copy Link

Version

Install

install.packages('rlang')

Monthly Downloads

1,956,217

Version

1.1.4

License

MIT + file LICENSE

Issues

108

Pull Requests

20

Stars

508

Forks

138

Maintainer

Lionel Henry

Last Published

June 4th, 2024

Functions in rlang (1.1.4)

args_dots_used

Helper for consistent documentation of used dots
as_box

Convert object to a box
args_error_context

Documentation anchor for error arguments
abort

Signal an error, warning, or message
args_dots_empty

Helper for consistent documentation of empty dots
arg_match

Match an argument to a character vector
UQ

Deprecated UQ() and UQS() operators
as_closure

Transform to a closure
args_data_masking

Argument type: data-masking
are_na

Test for missing values
as_data_mask

Create a data mask
box

Box a value
as_name

Extract names from symbols
as_utf8_character

Coerce to a character vector and attempt encoding conversion
as_function

Convert to function
bare-type-predicates

Bare type predicates
as_label

Create a default name for an R object
bytes-class

Human readable memory sizes
as_environment

Coerce to an environment
as_string

Cast symbol to string
call_name

Extract function name or namespace of a call
call_standardise

Standardise a call
call_inspect

Inspect a call
call_fn

Extract function from a call
caller_arg

Find the caller argument for error messages
catch_cnd

Catch a condition
check_exclusive

Check that arguments are mutually exclusive
call2

Create a call
check_required

Check that argument is supplied
call_args

Extract arguments from a call
check_dots_empty0

Check that dots are empty (low level variant)
check_dots_used

Check that all dots have been used
check_dots_unnamed

Check that all dots are unnamed
check_dots_empty

Check that dots are empty
call_modify

Modify the arguments of a call
call_match

Match supplied arguments to function definition
cnd

Create a condition object
dots_n

How many arguments are currently forwarded in dots?
chr_unserialise_unicode

Translate unicode points to UTF-8
child_env

Create a child environment
done

Box a final value for early termination
cnd_signal

Signal a condition object
dots_splice

Splice lists
dot-data

.data and .env pronouns
cnd_type

What type is a condition?
cnd_inherits

Does a condition or its ancestors inherit from a class?
dev-notes-dots

Development notes - dots.R
cnd_message

Build an error message from parts
defusing-advanced

Advanced defusal operators
cnd_muffle

Muffle a condition
empty_env

Get the empty environment
enquo

Defuse function arguments
env

Create a new environment
env_bind

Bind symbols to objects in an environment
entrace

Add backtrace from error handler
env_binding_are_active

What kind of environment binding?
env_cache

Cache a value in an environment
duplicate

Duplicate an R object
dots_values

Evaluate dots with preliminary splicing
embrace-operator

Embrace operator {{
env_browse

Browse environments
dyn-dots

Dynamic dots features
env_bury

Mask bindings by defining symbols deeper in a scope
env_clone

Clone or coalesce an environment
env_binding_lock

Lock or unlock environment bindings
env_has

Does an environment have or see bindings?
englue

Defuse function arguments with glue
env_lock

Lock an environment
env_inherits

Does environment inherit from another environment?
env_is_user_facing

Is frame environment user facing?
env_parent

Get parent environments
env_poke

Poke an object in an environment
env_unlock

Unlock an environment
eval_bare

Evaluate an expression in an environment
expr

Defuse an R expression
expr_interp

Process unquote operators in a captured expression
eval_tidy

Evaluate an expression with quosures and pronoun support
exec

Execute a function
expr_label

Turn an expression to a label
expr_print

Print an expression
format_error_call

Validate and format a function call for use in error messages
env_get

Get an object in an environment
env_depth

Depth of an environment chain
env_unbind

Remove bindings from an environment
env_print

Pretty-print an environment
friendly_type

Format a type for error messages
global_entrace

Entrace unexpected errors
get_env

Get or set the environment of an object
f_text

Turn RHS of formula into a string or label
faq-options

Global options for rlang
glue-operators

Name injection with "{" and "{{"
fn_env

Return the closure environment of a function
ffi_standalone_types_check

Internal API for standalone-types-check
exprs_auto_name

Ensure that all elements of a list of expressions are named
env_names

Names and numbers of symbols bound in an environment
env_name

Label of an environment
global_handle

Register default global handlers
fn_body

Get or set function body
inherits_any

Does an object inherit from a set of classes?
has_length

How long is an object?
flatten

Flatten or squash a list of lists into a simpler vector
format_error_bullets

Format bullets for error messages
injection-operator

Injection operator !!
inject

Inject objects in an R expression
f_rhs

Get or set formula components
fn_fmls

Extract arguments from a function
is_call

Is object a call?
invoke

Invoke a function with a list of arguments
has_name

Does an object have an element with this name?
hash

Hashing
interrupt

Simulate interrupt condition
is_expression

Is an object an expression?
global_prompt_install

Prompt user to install missing packages
is_dictionaryish

Is a vector uniquely named?
is_named

Is object named?
is_function

Is object a function?
is_empty

Is object an empty vector or NULL?
is_installed

Are packages installed in any of the libraries?
is_environment

Is object an environment?
is_lang

Is object a call?
is_copyable

Is an object copyable?
is_interactive

Is R running interactively?
last_error

Last abort() error
is_integerish

Is a vector integer-like?
local_options

Change global options
is_condition

Is object a condition?
is_callable

Is an object callable?
local_use_cli

Use cli to format error messages
missing

Missing values
lang

Create a call
is_namespace

Is an object a namespace environment?
local_bindings

Temporarily change bindings of an environment
is_pairlist

Is object a node or pairlist?
new_quosure

Create a quosure from components
local_error_call

Set local error call in an execution environment
new_node

Helpers for pairlist and language nodes
new_formula

Create a formula
new_quosures

Create a list of quosures
new_function

Create a function
new_weakref

Create a weak reference
missing_arg

Generate or handle a missing argument
ns_env

Get the namespace of a package
ns_registry_env

Return the namespace registry env
on_load

Run expressions on load
quo_squash

Squash a quosure
quo_label

Format quosures for printing or labelling
obj_address

Address of an R object
is_symbol

Is object a symbol?
is_formula

Is object a formula?
op-get-attr

Infix attribute accessor and setter
quosure-tools

Quosure getters, setters and predicates
is_reference

Is an object referencing another?
last_warnings

Display last messages and warnings
raw_deparse_str

Serialize a raw vector to a string
op-na-default

Replace missing values
rep_along

Create vectors matching the length of a given vector
scalar-type-predicates

Scalar type predicates
rlang_error

Errors of class rlang_error
return_from

Jump to or from a frame
rlib_trace_spec

Backtrace specification
rlang-package

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

Deprecated scoped functions
list2

Collect dynamic dots in a list
new_call

Create a new call from components
scoped_interactive

Deprecated scoped_ functions
qq_show

Show injected expression
is_true

Is object identical to TRUE or FALSE?
quo_expr

Squash a quosure
search_envs

Search path environments
new-vector

Create vectors matching a given length
set_expr

Set and get an expression
seq2

Increasing sequence of integers in an interval
stack

Get properties of the current or caller frame
stack-deprecated

Call stack information
set_attrs

Add attributes to an object
is_weakref

Is object a weak reference?
switch_type

Dispatch on base types
string

Create a string
set_names

Set names of a vector
sym

Create a symbol or list of symbols
topic-condition-customisation

Customising condition messages
rlang_backtrace_on_error

Display backtrace on error
parse_expr

Parse R code
pairlist2

Collect dynamic dots in a pairlist
names2

Get names of a vector
op-null-default

Default value for NULL
names_inform_repair

Inform about name repair
prim_name

Name of a primitive function
splice-operator

Splice operator !!!
splice

Splice values at dots collection time
topic-data-mask-programming

Data mask programming patterns
topic-condition-formatting

Formatting messages with cli
topic-double-evaluation

The double evaluation problem
topic-data-mask-ambiguity

The data mask ambiguity
topic-defuse

Defusing R expressions
topic-error-chaining

Including contextual information with error chains
topic-error-call

Including function calls in error messages
topic-embrace-constants

Why are strings and other constants enquosed in the empty environment?
topic-data-mask

What is data-masking and why do I need {{?
topic-embrace-non-args

Does {{ work on regular objects?
topic-metaprogramming

Metaprogramming patterns
trace_back

Capture a backtrace
type-predicates

Type predicates
try_fetch

Try an expression with condition handlers
vec_poke_n

Poke values into a vector
topic-multiple-columns

Taking multiple columns without ...
type_of

Base type of an object
topic-quosure

What are quosures and when are they needed?
topic-inject-out-of-context

What happens if I use injection operators out of context?
topic-inject

Injecting with !!, !!!, and glue syntax
vector-coercion

Coerce an object to a base type
zap

Create zap objects
zap_srcref

Zap source references
wref_key

Get key/value from a weak reference object
vector-construction

Create vectors
with_env

Evaluate an expression within a given environment
with_handlers

Establish handlers on the stack