R/tidalplane.R

In SDLfilter: Filtering and Assessing the Sample Size of Tracking Data

#' @aliases tidalplane
#' @title Tidal plane table for Sandy Strait, Australia
#' @description A semidiurnal tidal plane table containing the height of the mean tidal planes and the average time differences of tide 
#' at different locations within Sandy Strait.
#' @format A data frame with 2 rows and 6 variables:
#' \describe{
#'   \item{standard.port}{identifier for a tidal observation station.}
#'   \item{secondary.port}{identifier for a station at which tide is only predicted using the tidal records observed at the related standard port.}
#'   \item{lat}{latitude in decimal degrees.}
#'   \item{lon}{longitude in decimal degrees.}
#'   \item{timeDiff}{time difference between standard port and its associated secondary port.}
#'   \item{datumDiff}{baseline difference in metres between the bathymetry model and tidal observations/predictions, 
#'   if each data uses different datum (e.g. LAT and MSL).}
#' }
#' @source The State of Queensland (Department of Transport and Main Roads), Tidal planes.
"tidalplane"