R/estWeight.R

In krphillips/EchoNet2Fish: Estimate Fish Abundance from Acoustic Echoes and Net Catch

#' Estimate Fish Weight From Length
#'
#' Estimate fish weight from fish length.
#' @param Lmm
#'   A numeric vector, the total length of fish in mm.
#' @param lwa
#'   A numeric vector of the multiplicative parameter in a length-weight
#'   relation, in log(g).  See details.
#' @param lwb
#'   A numeric vector of the exponential parameter in a length-weight
#'   relation, in 1/log(mm).  See details.
#' @details
#'   The weight (in g) is calculated from the length-weight relation as
#'   Wg = \code{lwa} * \code{Lmm} ^ \code{lwb}.
#' @return
#'   A numeric vector of fish weights (in g), the same length as \code{Lmm}.
#' @export
#' @examples
#' paDens(c(0.001, 0.01, 0.1), c(4e-5, 5e-6, 8e-9))
#'
estWeight <- function(Lmm, lwa, lwb) {
  Wg <- lwa * Lmm ^ lwb
  return(Wg)
}