R/exploitation.R

In ypr: Yield Per Recruit

#' Exploitation Probability
#'
#' Converts capture probabilities into exploitation probabilities based on the
#' release and handling mortality probabilities where the probability of
#' exploitation includes handling mortalities. The calculation assumes that a
#' released fish cannot be recaught in the same year.
#'
#' In the case of no release (or 100% handling mortalities) the exploitation
#' probability is identical to the capture probability. Otherwise it is less.
#'
#' @inheritParams params
#' @param pi A vector of capture probabilities to calculate the exploitation
#'   probabilities for.
#' @return A vector of exploitation probabilities.
#' @family calculate
#' @export
#' @examples
#' ypr_exploitation(ypr_population(pi = 0.4))
#' ypr_exploitation(ypr_population(pi = 0.4, rho = 0.6, Hm = 0.2))
ypr_exploitation <- function(object, pi = ypr_get_par(object)) {
  chkor_vld(vld_is(object, "ypr_population"), vld_is(object, "ypr_ecotypes"))

  chk_numeric(pi)
  chk_not_any_na(pi)
  chk_range(pi)

  rho <- ypr_get_par(object, "rho")
  Hm <- ypr_get_par(object, "Hm")

  pi * (1 - rho) + pi * rho * Hm
}