R/original functions/applyMagneticDeclinationAdp.R

In Echisholm21/mooredDataProcessing_adcp: ADCP Processing

###applyMAgneticDeclination

#' @title ADCP Processing step 3.2
#'
#' @description apply magnetic declination to ADCP data
#'
#'
#' @param x adp object from oce-class
#' @param lat latitude
#' @param lon longitude
#' @param st start/ deployment time
#' @param et end/ recovery time
#' @param type average or interpolated
#'
#'
#'
#' @return adp object with magnetic declination applied given coordinates
#'
#' If type == average, an average is taken from start and end time declinations and applied uniformly
#'
#' If type == interpolated, the rate of declination is used over time series
#'
#'


applyMagneticDeclinationAdp <- function(x, lat = x[['latitude']], lon = x[['longitude']], st = x[['deploymentTime']], et = x[['recoveryTime']], type = 'average'){
  if (!inherits(x, "adp")){
    stop("method is only for objects of class '", "adp", "'")
  }
  if (type =='average'){
    #ifs for different time formats? tz argument?
    if (!is.na(lat) & !is.na(lon)){
      if(!is.null(st) & !is.null(et)){
    s <- as.POSIXct(st, tz = 'UTC')
    e <- as.POSIXct(et, tz = 'UTC')
    a <- magneticField(lon, lat, s)
    b <- magneticField(lon, lat, e)
    c <- round(mean(c(a$declination, b$declination)),digits = 2)
    coord <- x@metadata$oceCoordinate
    if (coord == 'enu'){
    x <- enuToOther(x, heading = c)
    x@metadata$magneticVariation <- c
    x@metadata$oceCoordinate <- 'enu'
    }
    if (coord != 'enu'){
      warning('Function cannot handle objects in ', coord, 'Object returned as is ; please convert to enu first')

      }
    }
    else {
      warning('Missing required arguments! No processing performed!')
    }
      x@processingLog$time <- processingLogAppend(x@processingLog, date())
    x@processingLog <- processingLogAppend(x@processingLog, value = paste0('magnetic variation applied; declination =', c, 'degrees') )
  }
    if (type == 'interpolate'){
      ;
    }
  return(x)


}
}