util_message {dataquieR}R Documentation

Produce a condition message with a useful short stack trace.

Description

Produce a condition message with a useful short stack trace.

Usage

util_message(
  m,
  ...,
  applicability_problem = NA,
  intrinsic_applicability_problem = NA,
  integrity_indicator = "none",
  level = 0,
  immediate,
  title = "",
  additional_classes = c()
)

Arguments

m

a message or a condition

...

arguments for sprintf on m, if m is a character

applicability_problem

logical TRUE, if an applicability issue, that is, the information for computation is missing (that is, an error that indicates missing metadata) or an error because the requirements of the stopped function were not met, e.g., a barplot was called for metric data. We can have logical or empirical applicability problems. empirical is the default, if the argument intrinsic_applicability_problem is left unset or set to FALSE.

intrinsic_applicability_problem

logical TRUE, if this is a logical applicability issue, that is, the computation makes no sense (for example, an error of unsuitable resp_vars). Intrinsic/logical applicability problems are also applicability problems. Non-logical applicability problems are called empirical applicability problems.

integrity_indicator

character the message is an integrity problem, here is the indicator abbreviation..

level

integer level of the message (defaults to 0). Higher levels are more severe.

immediate

logical not used.

additional_classes

character additional classes the thrown condition object should inherit from, first.

Value

condition the condition object, if the execution is not stopped

See Also

Other condition_functions: util_condition_constructor_factory(), util_deparse1(), util_error(), util_find_external_functions_in_stacktrace(), util_find_first_externally_called_functions_in_stacktrace(), util_find_indicator_function_in_callers(), util_suppress_warnings(), util_warning()


[Package dataquieR version 2.5.1 Index]