Man pages for rlang
Functions for Base Types and Core R and 'Tidyverse' Features
| abort | Signal an error, warning, or message |
| are_na | Test for missing values |
| arg_match | Match an argument to a character vector |
| args_data_masking | Argument type: data-masking |
| args_dots_empty | Helper for consistent documentation of empty dots |
| args_dots_used | Helper for consistent documentation of used dots |
| args_error_context | Documentation anchor for error arguments |
| as_box | Convert object to a box |
| as_closure | Transform to a closure |
| as_data_mask | 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_string | Cast symbol to string |
| as_utf8_character | Coerce to a character vector and attempt encoding conversion |
| bare-type-predicates | Bare type predicates |
| box | Box a value |
| bytes-class | Human readable memory sizes |
| call2 | Create a call |
| call_args | Extract arguments from a call |
| caller_arg | Find the caller argument for error messages |
| call_fn | Extract function 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_standardise | Standardise a call |
| catch_cnd | Catch a condition |
| check_dots_empty | Check that dots are empty |
| check_dots_empty0 | Check that dots are empty (low level variant) |
| 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_required | Check that argument is supplied |
| child_env | Create a child environment |
| chr_unserialise_unicode | Translate unicode points to UTF-8 |
| cnd | Create a condition object |
| cnd_inherits | Does a condition or its ancestors inherit from a class? |
| cnd_message | Build an error message from parts |
| cnd_muffle | Muffle a condition |
| cnd_signal | Signal a condition object |
| cnd_type | What type is a condition? |
| defusing-advanced | Advanced defusal operators |
| dev-notes-dots | Development notes - 'dots.R' |
| done | Box a final value for early termination |
| dot-data | '.data' and '.env' pronouns |
| dots_n | How many arguments are currently forwarded in dots? |
| dots_splice | Splice lists |
| dots_values | Evaluate dots with preliminary splicing |
| duplicate | Duplicate an R object |
| dyn-dots | Dynamic dots features |
| embrace-operator | Embrace operator {{ |
| empty_env | Get the empty environment |
| englue | Defuse function arguments with glue |
| enquo | Defuse function arguments |
| entrace | Add backtrace from error handler |
| env | Create a new environment |
| env_bind | Bind symbols to objects in an environment |
| env_binding_are_active | What kind of environment binding? |
| env_binding_lock | Lock or unlock environment bindings |
| env_browse | Browse environments |
| env_bury | Mask bindings by defining symbols deeper in a scope |
| env_cache | Cache a value in an environment |
| env_clone | Clone or coalesce an environment |
| env_depth | Depth of an environment chain |
| env_get | 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_user_facing | Is frame environment user facing? |
| env_lock | Lock 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_poke | Poke an object in an environment |
| env_print | Pretty-print an environment |
| env_unbind | Remove bindings from an environment |
| env_unlock | Unlock 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 |
| expr_interp | Process unquote operators in a captured expression |
| expr_label | Turn an expression to a label |
| expr_print | Print an expression |
| exprs_auto_name | Ensure that all elements of a list of expressions are named |
| faq-options | Global options for rlang |
| ffi_standalone_types_check | Internal API for standalone-types-check |
| flatten | Flatten or squash a list of lists into a simpler vector |
| fn_body | Get or set function body |
| fn_env | Return the closure environment of a function |
| fn_fmls | Extract arguments from a function |
| format_error_bullets | Format bullets for error messages |
| format_error_call | Validate and format a function call for use in error messages |
| f_rhs | Get or set formula components |
| friendly_type | Format a type for error messages |
| f_text | Turn RHS of formula into a string or label |
| 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 '"{{"' |
| hash | Hashing |
| has_length | How long is an object? |
| has_name | Does an object have an element with this name? |
| inherits_any | Does an object inherit from a set of classes? |
| inject | Inject objects in an R expression |
| injection-operator | Injection operator !! |
| interrupt | Simulate interrupt condition |
| invoke | Invoke a function with a list of arguments |
| is_call | Is object a call? |
| is_callable | Is an object callable? |
| is_condition | Is object a condition? |
| is_copyable | Is an object copyable? |
| is_dictionaryish | Is a vector uniquely named? |
| is_empty | Is object an empty vector or NULL? |
| is_environment | Is object an environment? |
| is_expression | Is an object an expression? |
| is_formula | Is object a formula? |
| is_function | Is object a function? |
| is_installed | Are packages installed in any of the libraries? |
| is_integerish | Is a vector integer-like? |
| is_interactive | Is R running interactively? |
| is_lang | Is object a call? |
| is_named | Is object named? |
| is_namespace | Is an object a namespace environment? |
| is_pairlist | Is object a node or pairlist? |
| is_reference | Is an object referencing another? |
| is_symbol | Is object a symbol? |
| is_true | Is object identical to TRUE or FALSE? |
| is_weakref | Is object a weak reference? |
| lang | Create a call |
| last_error | Last 'abort()' error |
| last_warnings | Display last messages and warnings |
| list2 | 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_options | Change global options |
| local_use_cli | Use cli to format error messages |
| missing | Missing values |
| missing_arg | Generate or handle a missing argument |
| names2 | Get names of a vector |
| names_inform_repair | Inform about name repair |
| new_call | Create a new call from components |
| new_formula | Create a formula |
| new_function | Create a function |
| new_node | Helpers for pairlist and language nodes |
| new_quosure | Create a quosure from components |
| new_quosures | Create a list of quosures |
| new-vector | Create vectors matching a given length |
| new_weakref | Create a weak reference |
| ns_env | Get the namespace of a package |
| ns_registry_env | Return the namespace registry env |
| obj_address | Address of an R object |
| on_load | Run expressions on load |
| op-get-attr | Infix attribute accessor and setter |
| op-na-default | Replace missing values |
| op-null-default | Default value for 'NULL' |
| pairlist2 | Collect dynamic dots in a pairlist |
| parse_expr | Parse R code |
| prim_name | Name of a primitive function |
| qq_show | Show injected expression |
| quo_expr | Squash a quosure |
| quo_label | Format quosures for printing or labelling |
| quo_squash | Squash a quosure |
| quosure-tools | Quosure getters, setters and predicates |
| raw_deparse_str | Serialize a raw vector to a string |
| rep_along | Create vectors matching the length of a given vector |
| return_from | Jump to or from a frame |
| rlang_backtrace_on_error | Display backtrace on error |
| rlang_error | Errors of class 'rlang_error' |
| rlang-package | rlang: Functions for Base Types and Core R and 'Tidyverse'... |
| rlib_trace_spec | Backtrace specification |
| scalar-type-predicates | Scalar type predicates |
| scoped_env | Deprecated 'scoped' functions |
| scoped_interactive | Deprecated 'scoped_' functions |
| search_envs | Search path environments |
| seq2 | Increasing sequence of integers in an interval |
| set_attrs | Add attributes to an object |
| set_expr | Set and get an expression |
| set_names | Set names of a vector |
| splice | Splice values at dots collection time |
| splice-operator | Splice operator !!! |
| stack | Get properties of the current or caller frame |
| stack-deprecated | Call stack information |
| string | Create a string |
| switch_type | Dispatch on base types |
| sym | Create a symbol or list of symbols |
| topic-condition-customisation | Customising condition messages |
| topic-condition-formatting | Formatting messages with cli |
| topic-data-mask | What is data-masking and why do I need {{? |
| topic-data-mask-ambiguity | The data mask ambiguity |
| topic-data-mask-programming | Data mask programming patterns |
| topic-defuse | Defusing R expressions |
| topic-double-evaluation | The double evaluation problem |
| topic-embrace-constants | Why are strings and other constants enquosed in the empty... |
| topic-embrace-non-args | Does {{ work on regular objects? |
| topic-error-call | Including function calls in error messages |
| topic-error-chaining | Including contextual information with error chains |
| topic-inject | Injecting with !!, !!!, and glue syntax |
| topic-inject-out-of-context | What happens if I use injection operators out of context? |
| topic-metaprogramming | Metaprogramming patterns |
| topic-multiple-columns | Taking multiple columns without '...' |
| topic-quosure | What are quosures and when are they needed? |
| trace_back | Capture a backtrace |
| try_fetch | Try an expression with condition handlers |
| type_of | Base type of an object |
| type-predicates | Type predicates |
| UQ | Deprecated 'UQ()' and 'UQS()' operators |
| vec_poke_n | Poke values into a vector |
| vector-coercion | Coerce an object to a base type |
| vector-construction | Create vectors |
| with_env | Evaluate an expression within a given environment |
| with_handlers | Establish handlers on the stack |
| wref_key | Get key/value from a weak reference object |
| zap | Create zap objects |
| zap_srcref | Zap source references |
