ssd_hc {ssdtools}R Documentation

Hazard Concentrations for Species Sensitivity Distributions

Description

Gets concentration(s) that protect specified percentage(s) of species.

Usage

ssd_hc(x, ...)

## S3 method for class 'list'
ssd_hc(x, percent = 5, hc = 5, ...)

## S3 method for class 'fitdists'
ssd_hc(
  x,
  percent = 5,
  hc = 5,
  ci = FALSE,
  level = 0.95,
  nboot = 1000,
  average = TRUE,
  delta = 7,
  min_pboot = 0.99,
  parametric = TRUE,
  control = NULL,
  ...
)

## S3 method for class 'fitburrlioz'
ssd_hc(
  x,
  percent = 5,
  ci = FALSE,
  level = 0.95,
  nboot = 1000,
  min_pboot = 0.99,
  parametric = FALSE,
  ...
)

Arguments

x

The object.

...

Unused.

percent

A numeric vector of percentages.

hc

A whole numeric vector between 1 and 99 indicating the percent hazard concentrations (deprecated for percent).

ci

A flag specifying whether to estimate confidence intervals (by parametric bootstrapping).

level

A number between 0 and 1 of the confidence level.

nboot

A count of the number of bootstrap samples to use to estimate the se and confidence limits. A value of 10000 is recommended for official guidelines.

average

A flag specifying whether to model average the estimates.

delta

A non-negative number specifying the maximum absolute Akaike Information-theoretic Criterion difference cutoff. Distributions with an absolute difference from the best model greater than the cutoff are excluded.

min_pboot

A number of the minimum proportion of bootstrap samples that must successfully fit in the sense of returning a likelihood.

parametric

A flag specifying whether to perform parametric as opposed to non-parametric bootstrapping.

control

A list of control parameters passed to stats::optim().

Details

If ci = TRUE uses parameteric bootstrapping to get confidence intervals on the hazard concentrations(s).

Value

A tibble of corresponding hazard concentrations.

Methods (by class)

See Also

predict.fitdists() and ssd_hp().

Examples

fits <- ssd_fit_dists(ssddata::ccme_boron)
ssd_hc(fits)
ssd_hc(estimates(fits))
ssd_hc(ssd_match_moments())
fit <- ssd_fit_burrlioz(ssddata::ccme_boron)
ssd_hc(fit)


[Package ssdtools version 1.0.6 Index]