R/Coastline-data.R

#' Coastline
#'
#' Coastline spatial line segment for modeling. The coastline should roughly
#' trace the water edge along the beach at the mean sea level. It is
#' recommended to keep this line segment simple and short. Remember that
#' perpendicular cross-shore transects will need to be generated from this
#' line. If the geometry is too complex with sharp curves, points, peninsulas
#' and bays, cross-shore profiles will point in undesirable directions.
#'
#' @docType data
#'
#' @usage data(Coastline)
#'
#' @format A simple feature LINESTRING of class sf and data.frame.
#'
#' @keywords datasets
#'
#' @examples
#' \donttest{
#' require(sf)
#' data(Coastline)
#' head(Coastline)
#' # Plot the coastline
#' plot(sf::st_geometry(Coastline))
#' }
"Coastline"
essatech/MNAI.CPBT documentation built on July 1, 2023, 12:34 p.m.