R/calc_finalheight_diff.R

In tesseracrockett/crockett.pkg: Ecotox plant data analysis

#'Calculate final plant height into new column
#'
#'@param ecotox name of tibble 'ecotox' (tibble, no default)
#'@param HEIGHT_F final height of plant in cm (numeric, no default)
#'@param HEIGHT_I initial height of plant in cm (numeric, no default)
#'@return difference (numeric)
#'@importFrom assertthat assert_that
#'@importFrom dplyr mutate
#'@importFrom magrittr "%>%"
#'@export
#'
#'@examples 
#'calc_finalheight_diff (HEIGHT_F-HEIGHT_I)
#'
calc_finalheight_diff <- function(data = ecotox,
                                  HEIGHT_F = ecotox$HEIGHT_F,
                                  HEIGHT_I = ecotox$HEIGHT_I)
{assertthat::assert_that(is.numeric(HEIGHT_F))
  assertthat::assert_that(is.numeric(HEIGHT_I))
  fh_diff <- data %>% mutate(fh_diff = 
                              (ecotox$HEIGHT_F
                               -ecotox$HEIGHT_I))
return(fh_diff)}