R/weight2kg.R

In clinPK: Clinical Pharmacokinetics Toolkit

#' Convert any weight unit to kg
#'
#' @param value weight in any allowed unit
#' @param unit unit of weight, one of "lb", "lbs", "pound", "pounds", "oz", "ounce", "ounces", "g", "gram", "grams"
#' @examples
#' weight2kg(250, unit = "oz")
#' weight2kg(250, unit = "pounds")
#' weight2kg(250, unit = "lbs")
#' @export
weight2kg <- function(value = NULL, unit = NULL) {
  if(is.null(value)) {
    stop("No weight value specified.")
  }
  if(!is.null(unit) && !is.na(unit)) {
    if(tolower(unit) %in% valid_units("weight")) {
      if(tolower(unit) %in% c("lb", "lbs", "pound", "pounds")) {
        value <- value / 2.20462
      }
      if(tolower(unit) %in% c("oz", "ounce", "ounces")) {
        value <- value / 35.274
      }
      if (tolower(unit) %in% c("g", "gram", "grams")) {
        value <- value / 1000
      }
    } else {
      stop(paste0("Unit (", unit,") not recognized."))
    }
  } else {
    stop("Weight unit not specified.")
  }
  return(value)
}