elfgen {elfgen}

R Documentation

Generate Ecological Limit Function (ELF)

Description

Generate ELF models by supplying a dataframe of richness and stream size data (streamflow or drainage area), a quantile for evaluating the ecological limit, and a breakpoint threshold.

Usage

elfgen(
  watershed.df,
  quantile,
  breakpt,
  yaxis_thresh,
  xlabel = FALSE,
  ylabel = FALSE
)

Arguments

watershed.df	A dataframe of sites with ecological and hydrologic data
quantile	A specified value for the quantile of interest - 0.95 equals the 95th percentile
breakpt	A breakpoint - either user-supplied fixed value or derived using elfgen breakpoint functions bkpt_pwit() or bkpt_ymax
yaxis_thresh	Value used for specifying y-axis max limit
xlabel	Used to overwrite default x-axis label
ylabel	Used to overwrite default y-axis label

Value

Object containing plot image and dataframe of ELF statistics

Examples

# We don't run this example by R CMD check, because it takes >10s

watershed.df <- elfdata(watershed.code = '0208020104', ichthy.localpath = tempdir())
breakpt <- 500
elfgen(
   "watershed.df" = watershed.df,
   "quantile" = 0.80,
   "breakpt" = breakpt,
   "xlabel" = "Mean Annual Flow (ft3/s)",
   "ylabel" = "Fish Species Richness"
   )

---