anlz_attainsite: Get site attainments

View source: R/anlz_attainsite.R

anlz_attainsiteR Documentation

Get site attainments

Description

Get site attainment categories for chlorophyll or light attenuation

Usage

anlz_attainsite(
  avedatsite,
  thr = c("chla", "la"),
  trgs = NULL,
  yrrng = NULL,
  thrs = FALSE
)

Arguments

avedatsite

result returned from anlz_avedatsite

thr

chr string indicating with water quality value and appropriate threshold to to plot, one of "chl" for chlorophyll and "la" for light availability

trgs

optional data.frame for annual bay segment water quality targets, defaults to targets

yrrng

optional numeric value for year to return, defaults to all

thrs

logical indicating if attainment category is relative to targets (default) or thresholds

Details

This function is a simplication of the attainment categories returned by anlz_attain. Sites are only compared to the targets/thresholds that apply separately for chlorophyll or light attenuation.

Value

a data.frame for each year and site showing the attainment category

Examples

avedatsite <- anlz_avedatsite(epcdata)
anlz_attainsite(avedatsite)

tbep-tech/tbeptools documentation built on April 13, 2025, 4:50 p.m.