Skip to contents

Validate Numeric Arguments

Source: R/dis_numeric.R
dis_numeric.Rd

This function runs standard unit tests on numeric and integer parameters for functions.

Usage

dis_numeric(x, valid = NULL, null_valid = TRUE, na_valid = FALSE,
    nan_valid = FALSE, infinite_valid = FALSE, integer = FALSE, scalar = TRUE,
    param = NULL, call = NULL, fact_check = "global")

Arguments

x

Required object; a parameter argument to test.

valid

Optional numeric scalar or vector; valid values for the parameter.

null_valid

Required logical scalar; whether the parameter can be NULL. If FALSE, the function will throw an error if x is NULL. Default is TRUE.

na_valid

Required logical scalar; whether the parameter can be NA. If FALSE, the function will throw an error if x is NA. Default is FALSE.

nan_valid

Required logical scalar; whether the parameter can be NaN. If FALSE, the function will throw an error if x is NaN. Default is FALSE.

infinite_valid

Required logical scalar; whether the parameter can be Inf or -Inf. If FALSE, the function will throw an error if x is infinite. Default is FALSE.

integer

Required logical scalar; whether the parameter must be an integer. If TRUE, the function will throw an error if x is not an integer. Default is FALSE.

scalar

Required logical scalar; whether the parameter must be a scalar. If TRUE (default), the function will throw an error if x is not a scalar.

param

Optional character scalar; the parameter name. If NULL (default), the function will attempt to determine the parameter name from the calling environment. If nesting functions, it is recommended to provide the parameter name to ensure the correct parameter is referenced using rlang::caller_arg().

call

Optional environment; the environment in which the function was called. If NULL (default), the function will attempt to determine the calling environment. If nesting functions, it is recommended to provide the calling environment to ensure the correct environment is referenced using rlang::caller_env().

fact_check

Required character scalar; whether to override fact checking environment setting. If "global" (default), dis_character will follow the global setting. If "always", dis_character will ignore any global setting and will always check x. This argument is primarily intended for Shiny developers who wish to use disputeR in modules. See the vignette on vignette("developing", package = "disputeR") for details on how to use this function.

Value

This function will return either TRUE (if the input passes all validation checks) or an error message. Note that, if the input is NULL, NA, NaN, or infinite and the appropriate arguments are set to TRUE, the detailed unit tests are skipped and the function will return TRUE.

Details

See the vignette on vignette("developing", package = "disputeR") for details about internal validation of arguments for this function.

Examples

# create example function that uses dis_numeric()
example <- function(x){

  ## check inputs with disputeR
  dis_not_missing(.f = rlang::is_missing(x))
  dis_numeric(x, null_valid = FALSE)

  ## square
  out <- x^2

  ## return output
  return(out)

}

# test example function
example(x = 2)
#> [1] 4