exceed: exceed

exceedR Documentation

exceed

Description

Determines if water data contains observations that exceed a upper and/or lower assessment points.

Usage

exceed(
  object,
  parkcode = NA,
  sitecode = NA,
  charname = NA,
  category = NA,
  points = "both",
  lower = NA,
  upper = NA,
  all = F,
  catsum = F,
  ...
)

Arguments

object

One of a Characteristic object, a Site object, a Park object or a list of such objects.

parkcode

One or more parkcodes, in quotes. If object is a Park object or a list of Park objects, then the parkcode argument can be used to select which sites should be used.

sitecode

One or more sitecodes, in quotes. If object is a Park object or a list of Park or Site objects, then the sitcode argument can be used to select which sites should be used.

charname

Name of one or more characteristics, in quotes. Only those characteristics will be returned.

category

One or more categories of characteristics, in quotes. Only those categories of characteristics will be returned.

points

What assessment points to use when determining if there are exceedances. There are three options

"lower"

Only assess the data against the lower reference point

"upper"

Only assess the data against the upper reference point

"both"

The default. Assess the data against both reference points

lower, upper

The lower and uppers assessment points. Either a number specified by the user, or if NA, the default, the assessment point is determined by the LowerPoint and UpperPoint slots in the Characteristic objects.

all

Logical, defaults to FALSE. Not used when object is a data.frame. If all is FALSE characteristics without upper or lower references points will not be included in the results. If all is TRUE such characteristics will be included.

catsum

Logical, defaults to False. When true summarizes by category rather than a characteristic. Not used if object is a data.frame

...

Additional commands passed to getWData for filtering or subsetting the data.


NCRN/NCRNWater documentation built on May 15, 2023, 9:50 p.m.