R/convenience_functions.R

In neyhartj/pbr: Companion to Plant Breeding in R

#' Convenience functions
#'
#' @description
#' Convenience functions. These are generally not to be called by the user
#'
#' @param x A numeric vector or maxtrix.
#'
#' @details
#'
#' The formula for the harmonic mean given in the function \code{harm_mean} is:
#'
#' \eqn{e_h = n / \sum{\frac{1}{e_j}}}
#'
#' By default, the function will remove infinite values and calculate the sum
#' using non-missing values.
#'
#' @references
#' Holland, J.B., W.E. Nyquist, and C.T. Cervantes-Martinez. 2003. Estimating and
#' Interpreting Heritability for Plant Breeding. p. 9-112. In Janick, J. (ed.),
#' Plant Breed. Rev. John Wiley & Sons, Inc.
#'
#'
#' @export
#'
harm_mean <- function(x) {
  inv_x <- 1 / x
  inv_x[is.infinite(inv_x)] <- NA
  1 / mean(inv_x, na.rm = TRUE)
}