_pkgdown.yml

template:
  package: tidytemplate
  default_assets: false

home:
  strip_header: true

reference:
  - title: Quote expressions
    desc: >
      These functions support quasiquotation. They return quosures or
      raw expressions.
    contents:
      - quo
      - enquo
      - quos
      - expr
      - enexpr
      - exprs
      - quasiquotation
      - UQ
      - UQS
      - UQE
  - title: Evaluate expressions
    contents:
      - eval_tidy
      - eval_bare
      - invoke
      - with_env
      - locally
  - title: Symbols
    contents:
      - sym
      - syms
      - is_symbol
  - title: Calls
    contents:
      - lang
      - is_lang
      - is_unary_lang
      - is_binary_lang
      - lang_modify
      - lang_standardise
      - lang_fn
      - lang_name
      - lang_head
      - lang_tail
      - lang_args
      - lang_args_names
      - is_callable
      - switch_lang
      - coerce_lang
      - lang_type_of
  - title: Expressions
    contents:
      - is_expr
      - is_syntactic_literal
      - is_symbolic
      - expr_text
      - expr_label
      - expr_name
      - set_expr
      - get_expr
      - parse_expr
      - parse_exprs
      - parse_quosure
      - parse_quosures
      - expr_interp
      - exprs_auto_name
  - title: Quosures
    contents:
      - new_quosure
      - is_quosure
      - is_quosureish
      - as_quosure
      - as_quosureish
      - quo_is_missing
      - quo_is_symbol
      - quo_is_lang
      - quo_is_symbolic
      - quo_is_null
      - quo_expr
      - quo_text
      - quo_label
      - quo_name
      - is_quosures
      - quos_auto_name
  - title: Formulas
    contents:
      - new_formula
      - is_formula
      - is_bare_formula
      - is_formulaish
      - f_rhs
      - f_lhs
      - f_env
      - "`f_env<-`"
      - f_text
      - f_label
      - f_name
  - title: Pairlists and language nodes
    contents:
      - pairlist
      - node
      - node_car
      - node_cdr
      - node_caar
      - node_cadr
      - node_cdar
      - node_cddr
      - mut_node_car
      - mut_node_cdr
      - mut_node_caar
      - mut_node_cadr
      - mut_node_cdar
      - mut_node_cddr
      - node_tag
      - mut_node_tag
      - as_pairlist
      - is_pairlist
      - duplicate
  - title: Functions
    contents:
      - new_function
      - fn_fmls
      - fn_fmls_names
      - fn_fmls_syms
      - is_function
      - is_closure
      - is_primitive
      - is_primitive_eager
      - is_primitive_lazy
      - prim_name
      - fn_env
      - "`fn_env<-`"
      - as_function
      - as_closure
  - title: Environments
    contents:
      - env
      - child_env
      - as_env
      - env_parent
      - env_tail
      - env_parents
      - env_depth
      - get_env
      - set_env
      - env_bind
      - env_bind_exprs
      - env_bind_fns
      - env_bury
      - env_unbind
      - env_has
      - env_get
      - env_names
      - env_clone
      - env_inherits
      - is_env
      - is_bare_env
  - title: Search path and namespaces
    contents:
      - scoped_env
      - scoped_names
      - scoped_envs
      - is_scoped
      - pkg_env
      - pkg_env_name
      - base_env
      - global_env
      - empty_env
      - ns_env
      - ns_imports_env
      - ns_env_name
      - is_installed
  - title: Create vectors
    desc: >
      Atomic vector constructors have implicit splicing (i.e. splice
      lists automatically), while the list constructor has explicit
      splicing.
    contents:
      - lgl
      - int
      - dbl
      - cpl
      - chr
      - bytes
      - ll
      - string
      - rep_along
      - lgl_along
      - int_along
      - dbl_along
      - cpl_along
      - chr_along
      - raw_along
      - bytes_along
      - list_along
      - lgl_len
      - int_len
      - dbl_len
      - cpl_len
      - chr_len
      - raw_len
      - bytes_len
      - list_len
  - title: Coerce vectors
    desc: >
      These coercers skip S3 dispatch and have stricter implicit
      coercion rules.
    contents:
      - as_logical
      - as_integer
      - as_double
      - as_complex
      - as_character
      - as_string
      - as_list
      - as_bytes
  - title: Flatten and squash vectors
    contents:
      - flatten
      - flatten_lgl
      - flatten_int
      - flatten_dbl
      - flatten_cpl
      - flatten_chr
      - flatten_raw
      - squash
      - squash_lgl
      - squash_int
      - squash_dbl
      - squash_cpl
      - squash_chr
      - squash_raw
      - flatten_if
      - squash_if
      - splice
      - is_spliced
      - is_spliced_bare
  - title: Vectors tools
    contents:
      - prepend
      - modify
      - seq2
      - seq2_along
  - title: Missing values
    contents:
      - na_lgl
      - na_int
      - na_dbl
      - na_chr
      - na_cpl
      - are_na
      - is_na
      - is_lgl_na
      - is_int_na
      - is_dbl_na
      - is_cpl_na
      - is_chr_na
  - title: Attributes
    contents:
      - set_attrs
      - mut_attrs
      - set_names
      - names2
      - is_named
      - is_dictionaryish
      - have_name
      - has_name
      - has_length
  - title: Encoding
    contents:
      - as_utf8_character
      - as_native_character
      - as_utf8_string
      - as_native_string
      - set_chr_encoding
      - chr_encoding
      - set_str_encoding
      - str_encoding
      - mut_utf8_locale
      - mut_latin1_locale
      - mut_mbcs_locale
  - title: Vectors and lists predicates
    contents:
      - is_list
      - is_atomic
      - is_vector
      - is_integer
      - is_double
      - is_character
      - is_logical
      - is_raw
      - is_bytes
      - is_scalar_list
      - is_scalar_atomic
      - is_scalar_vector
      - is_scalar_integer
      - is_scalar_double
      - is_scalar_character
      - is_scalar_logical
      - is_scalar_raw
      - is_scalar_bytes
      - is_bare_list
      - is_bare_atomic
      - is_bare_vector
      - is_bare_double
      - is_bare_integer
      - is_bare_numeric
      - is_bare_character
      - is_bare_logical
      - is_bare_raw
      - is_bare_bytes
      - is_empty
      - is_integerish
      - is_bare_integerish
      - is_scalar_integerish
  - title: Other R types and objects predicates
    contents:
      - is_null
      - is_true
      - is_false
      - is_string
      - is_bare_string
      - is_copyable
      - type_of
      - switch_type
      - coerce_type
      - switch_class
      - coerce_class
      - friendly_type
  - title: Operators
    contents:
      - "`%||%`"
      - "`%|%`"
      - "`%@%`"
      - "`:=`"
      - new_definition
      - is_definition
  - title: Capture dots
    desc: >
      Capture dots with different kinds of splicing semantics.
    contents:
      - dots_list
      - dots_splice
      - dots_values
      - dots_definitions
      - dots_n
  - title: Tidy evaluation and overscoping
    desc: >
      Most of the time you only need `eval_tidy()`, but these
      functions can be useful if you are writing your own grammar.
    contents:
      - "`tidyeval-data`"
      - eval_tidy_
      - as_overscope
      - new_overscope
      - overscope_eval_next
      - overscope_clean
      - as_dictionary
      - is_dictionary
  - title: Function arguments
    contents:
      - arg_match
      - missing_arg
      - is_missing
      - maybe_missing
  - title: Call and context stacks
    desc: >
      The call stack is a subset of the context stack where nuisance
      frames due to lazy evaluation are removed. It is easier to
      analyse than the full context stack. Stacks are list of frames,
      which are S3 objects with a nice print method for visualing call
      frames.
    contents:
      - ctxt_stack
      - call_stack
      - is_stack
      - is_eval_stack
      - is_call_stack
      - ctxt_frame
      - call_frame
      - is_frame
      - global_frame
      - current_frame
      - caller_env
      - caller_frame
      - caller_fn
      - ctxt_depth
      - call_depth
      - frame_position
      - stack_trim
      - return_from
      - return_to
      - call_inspect
  - title: Create conditions
    desc: >
      These helpers make it easy to create typed conditions.
    contents:
      - ends_with("cnd")
      - is_condition
  - title: Signal conditions
    contents:
      - abort
      - warn
      - inform
      - cnd_signal
      - cnd_abort
  - title: Restarts
    contents:
      - with_restarts
      - rst_list
      - rst_exists
      - rst_jump
      - rst_maybe_jump
      - rst_abort
      - rst_muffle
  - title: Condition handlers
    contents:
      - with_handlers
      - exiting
      - inplace
      - restarting

navbar:
  type: default
  left:
  - text: Reference
    href: reference/index.html
  - text: Articles
    menu:
    - text: Tidy evaluation
      href: articles/tidy-evaluation.html
  - text: News
    href: news/index.html