R/temp_calc.R

In USGS-R/GDopp: processing of ADV data

#'@title block-averaged temperature
#'@description 
#'Water temperature average for within block  \cr
#'
#'@details a \code{GDopp} function for averaging water temperature measurements from ADV sensor (1Hz).\cr 
#'assumes one second spin-up for high-frequency measurement, and a likely incomplete final second for high frequency.
#'
#'@param data.sen a data.frame created with load.ADV, with the window.idx column
#'@param window.idx window.idx column from adv data.frame.
#'@param freq the frequency (Hz) of the measurements
#'@return a vector of averaged values
#'@keywords methods, math
#'@seealso \link{time_calc}, \link{load_adv}, \link{load_sen}
#'@examples 
#'\dontrun{
#'folder.nm <- system.file('extdata', package = 'GDopp') 
#'file.nm <- "ALQ102.dat"
#'data.adv <- load_adv(file.nm=file.nm, folder.nm =folder.nm)
#'window.adv <- window_adv(data.adv,freq=32,window.mins=10)
#'data.sen <- load_sen(file.nm="ALQ102.sen", folder.nm = folder.nm)
#'
#'temps <- temp_calc(data.sen,window.adv$window.idx,freq=32)
#'time <- time_calc(data.sen,window.adv$window.idx,freq=32)
#'plot(time,temps)
#'}
#'@export
temp_calc <- function(data.sen,window.idx,freq=32){
  
  pass_vars <- data.sen[, names(data.sen) %in% c("temperature")]
  
  temp <- match_time(value=pass_vars, window.idx, freq)

  return(temp)
}