ectdStop: Error handling functions for the ectd package.

In MikeKSmith/MSToolkit: The MSToolkit Library For Clinical Trial Design

Error handling functions for the ectd package.

Description

These functions are alias to the standard R functions stop and warning, but they also do character interpolation. See examples.

Usage

ectdStop(msg, call. = TRUE, domain = NULL, verbose = getEctdVerbose())

ectdWarning(..., call. = TRUE, immediate. = FALSE, domain = NULL)

Arguments

msg	(Required) Message to be displayed to the user
call.	logical, indicating if the call should become part of the error message.
domain	see gettext. If NA, messages will not be translated.
verbose	(Optional) Should more details be given when showing the error message/warning. By default, this is controlled by support function getEctdVerbose
...	zero or more objects which can be coerced to character (and which are pasted together with no separator) or a single condition object.
immediate.	logical, indicating if the call should be output immediately, even if getOption("warn") <= 0.

Value

Nothing.

Functions

• ectdWarning(): Error handling functions for the ectd package.

Author(s)

Rich Pugh

See Also

See warning and stop.

Examples

  ## Not run: 
     ectdStop("something wrong happened")
  
## End(Not run)

MikeKSmith/MSToolkit documentation built on Feb. 15, 2024, 5:32 p.m.