check.1.integer: Check Argument Type and Length

In spatstat.utils: Utility Functions for 'spatstat'

Check Argument Type and Length

Description

These utility functions check whether a given argument is a single value of the required type.

Usage

check.1.real(x, context = "", fatal = TRUE, warn=TRUE)
check.1.integer(x, context = "", fatal = TRUE, warn=TRUE)
check.1.string(x, context = "", fatal = TRUE, warn=TRUE)

Arguments

x	The argument to be checked.
context	Optional string describing the context in which the argument is checked.
fatal	Logical value indicating whether a fatal error should occur when x is not of the required type.
warn	Logical value indicating whether to issue a warning message if x is not of the required type.

Details

These functions check whether the argument x is a single atomic value of type numeric, integer or character.

If x does have the required length and type, the result of the function is the logical value TRUE.

Otherwise, if fatal=TRUE (the default) an error occurs, while if fatal=FALSE a warning is issued (if warn=TRUE) and the function returns the value FALSE.

Value

A logical value (or an error may occur).

Author(s)

\adrian

.

See Also

check.named.vector

Examples

  x <- pi
  check.1.real(x)
  check.1.integer(pi, fatal=FALSE, context="In your dreams,")
  check.1.string(x, fatal=FALSE)
  check.1.integer(x, fatal=FALSE, warn=FALSE)

spatstat.utils documentation built on Oct. 24, 2023, 9:08 a.m.