R/datasets-docs.R

In ggOceanMaps: Plot Data on Oceanographic Maps using 'ggplot2'

#' @title Major fisheries areas (hovedomraade) of Norway
#' @docType data
#' @encoding UTF-8
#' @keywords datasets shapefiles fishery
#' @family datasets
#' @name fdir_main_areas
#' @format \code{\link[sf:st_sf]{sf object}} containing major fishing zones defined by the Norwegian Directorate of Fisheries. Contains also Northwest Atlantic Fisheries Organization's divisions where Norwegian vessels tend to fish.
#' @source \href{https://open-data-fiskeridirektoratet-fiskeridir.hub.arcgis.com/}{Norwegian Directorate of Fisheries} and \href{https://www.nafo.int/About-us/Maps}{Northwest Atlantic Fisheries Organization}
#' @importFrom sf st_sf
#' @examples
#' if(requireNamespace("ggspatial")) {
#' \donttest{ 
#' basemap(fdir_main_areas) + 
#' ggspatial::annotation_spatial(fdir_main_areas, fill = NA)
#' }
#' }
"fdir_main_areas"

#' @title Norwegian sub-areas (lokasjon) for commercial fishing
#' @docType data
#' @encoding UTF-8
#' @keywords datasets shapefiles fishery
#' @family datasets
#' @name fdir_sub_areas
#' @format \code{\link[sf:st_sf]{sf object}} containing major fishing zones defined by the Norwegian Directorate of Fisheries.
#' @source \href{https://open-data-fiskeridirektoratet-fiskeridir.hub.arcgis.com/}{Norwegian Directorate of Fisheries}
#' @importFrom sf st_sf
#' @examples 
#' if(requireNamespace("ggspatial")) {
#' \donttest{
#' basemap(fdir_sub_areas) + 
#' ggspatial::annotation_spatial(fdir_sub_areas, fill = NA)
#' }
#' }
"fdir_sub_areas"

#' @title ICES Advisory Areas
#' @docType data
#' @encoding UTF-8
#' @keywords datasets shapefiles fishery
#' @family datasets
#' @name ices_areas
#' @format \code{\link[sf:st_sf]{sf object}} containing ICES Advisory Areas.
#' @source \href{https://www.ices.dk/}{International Council for the Exploration of the Sea}
#' @importFrom sf st_sf
#' @examples
#' if(requireNamespace("ggspatial")) {
#' \donttest{
#' basemap(ices_areas) + 
#' ggspatial::annotation_spatial(ices_areas, fill = NA)
#' }
#' }
"ices_areas"