wregValidation: Validation Scheme for WREG

Description Usage Arguments Details Value Examples

View source: R/wregValidation.R

Description

The wregValidation function validates input in WREG-R.

Usage

1
wregValidation(input, mode, compare = NULL, message = NULL, warnFlag = FALSE)

Arguments

input

A value to validate.

mode

Method of validation

compare

(optional) Value to compare against if mode requires comparison

message

(optional) Custom message for warning/error

warnFlag

(optional) Whether or not invalid input should throw a warning/error

Details

This functions streamlines validation for the programmer so less lines of code are written

Value

TRUE or FALSE depending on validity of input or throws an error

Examples

1
invalid <- wregValidation(0, "eq", 0)

wfarmer-usgs/WREG documentation built on July 24, 2020, 1:28 a.m.