R/function_database.R

In joshoriv/rivera.package: Analyze Siren Shape Data

#' Calculate volume of shrub
#' 
#' @param length length of shrub (numeric, default 1)
#' @param width Width of shrub (numeric, default 1)
#' @param height Height of shrub (numeric, default 1)
#' @return volume of shrub (numeric)
#' 
#' @examples 
#' calc_chrub_vol(length = 2, width = 3, height = 2)

calc_shrub_vol <- function(length = 1, width = 1, height = 1){
  volume <- length*width*height
  return(volume)
}

#' Calculate mass of shrub
#' 
#' @param volume volume of shrub (numeric)
#' @return mass of shrub (numeric)
#' 
#' @examples
#' calc_shrub_mass(3)

calc_shrub_mass <- function(volume){
  mass <- 2.65 * volume^0.9
  return(mass)
}

#' Calculate density of shrub
#' 
#' @param length length of shrub (numeric, default 4)
#' @param width Width of shrub (numeric, default 2)
#' @param height Height of shrub (numeric, default 1)
#' @param volume volume of shrub (numeric)
#' @param mass mass of shrub (numeric)
#' @return density of shrub (numeric)
#' 

calc_shrub_density <- function(width = 2, length = 4, height = 1){
  vol <- calc_shrub_vol(width, length, height)
  mass <- est_shrub_mass(vol)
  den <- mass/vol
  return(den)
}