compare_options: Options for waldo::compare

In constructive: Display Idiomatic Code to Construct Most R Objects

Options for waldo::compare

Description

Builds options that will be passed to waldo::compare() down the line.

Usage

compare_options(
  ignore_srcref = TRUE,
  ignore_attr = FALSE,
  ignore_function_env = FALSE,
  ignore_formula_env = FALSE
)

Arguments

ignore_srcref	Ignore differences in function srcrefs? TRUE by default since the srcref does not change the behaviour of a function, only its printed representation.
ignore_attr	Ignore differences in specified attributes? Supply a character vector to ignore differences in named attributes. By default the "waldo_opts" attribute is listed in ignore_attr so that changes to it are not reported; if you customize ignore_attr, you will probably want to do this yourself. For backward compatibility with all.equal(), you can also use TRUE, to all ignore differences in all attributes. This is not generally recommended as it is a blunt tool that will ignore many important functional differences.
ignore_function_env, ignore_formula_env	Ignore the environments of functions and formulas, respectively? These are provided primarily for backward compatibility with all.equal() which always ignores these environments.

Value

A list

constructive documentation built on April 3, 2025, 9:39 p.m.