bbnj: Biodiversity Beyond National Jurisdiction

#' Raster of planning unit id for high seas
#'
#' Global half-degree raster of high seas with unique id.
#'
#' @format A \code{\link[raster]{raster}} with integer of id unique to cell.
"r_pu_id"

#' Polygon of areas beyond national jurisdiction, ie high seas area
#'
#' Global area [-180,180,-90,90] with land and Exclusive Economic Zones (EEZs)
#' clipped out using the "Intersect_EEZ_IHO_v3_2018" product from \href{http://MarineRegions.org}{MarineRegions.org}.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_abnj"

#' Polygon of Pelagic Provinces of the World (Spalding et al, 2012) for high
#' seas
#'
#' See \url{http://data.unep-wcmc.org/datasets/38}. Clipped to high seas. TODO: merge
#' small areas with larger ones.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_ppow"

#' Simplified polygon of Pelagic Provinces of the World (Spalding et al, 2012) for high
#' seas
#'
#' See \url{http://data.unep-wcmc.org/datasets/38}. Clipped to high seas. TODO: merge
#' small areas with larger ones. Simplified to 5% of original vertices for fast visualization.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_ppow_s05"

#' Polygon of IHO Seas
#'
#' See \url{http://www.marineregions.org/sources.php#iho}. Clipped to high seas. TODO:
#' merge small areas with larger ones.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_iho"

#' Simplified polygon of IHO Seas
#'
#' See \url{http://www.marineregions.org/sources.php#iho}. Clipped to high seas. TODO:
#' merge small areas with larger ones. Simplified to 5% of original vertices for fast visualization.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_iho_s05"

#' Polygon of IHO Seas Revised, ie Seven Seas
#'
#' See \url{http://www.marineregions.org/sources.php#iho}. Clipped to high seas.
#' Merged smaller areas to the top 7 seas by taking the nearest sea from the
#' centroid.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_ihor"

#' Stack of rasters describing presence of seven seas from IHO revised (IHOR)
#'
#' Global half-degree stack of seven seas in the high seas by seaid (alphabetical):
#' \enumerate{
#'   \item Arctic Ocean
#'   \item Indian Ocean
#'   \item North Atlantic Ocean
#'   \item North Pacific Ocean
#'   \item South Atlantic Ocean
#'   \item South Pacific Ocean
#'   \item Southern Ocean
#' }
#'
#' @format A \code{\link[raster]{stack}} of \code{seaid} [1-7] with raster
#'   attribute table providing \code{sea} and \code{area_km2} (see
#'   \code{\link[raster]{factorValues}()}).
"s_ihor"

#' Simplified polygon of IHO Seas Revised, ie Seven Seas
#'
#' See \url{http://www.marineregions.org/sources.php#iho}. Clipped to high seas.
#' Merged smaller areas to the top 7 seas by taking the nearest sea from the
#' centroid. Simplified to 5% of original vertices for fast visualization.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_ihor_s05"

#' Simplified polygon of areas beyond national jurisdiction, ie high seas area
#'
#' Global area [-180,180,-90,90] with land and Exclusive Economic Zones (EEZs)
#' clipped out using the "Intersect_EEZ_IHO_v3_2018" product from \href{http://MarineRegions.org}{MarineRegions.org}.
#' Simplified to 5% of original vertices for fast visualization.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_abnj_s05"

#' Simplified polygons of exclusive economic zones (EEZs)
#'
#' Downloaded World_EEZ_v10_20180221/eez_v10.shp from \href{http://MarineRegions.org}{MarineRegions.org}. For
#' quick mapping applied simplification using
#' \code{\link[rmapshaper]{ms_simplify}(keep = 0.5)} twice.
#'
#' @format A \code{\link[sf]{sf}} object of a polygon.
"p_eez_s05"

#' Raster stack of global marine biodiversity indicators from AquaMaps and IUCN
#'
#' Dataset containing global half-degree rasters clipped to the high seas of
#' species richness (\code{nspp_*}) and Red List Sum (\code{rls_*})  package
#' \href{https://github.com/marinebon/bbnj}{marinebon/bbnj}.
#'
#' @format A \code{\link[raster]{stack}} with indicator (\code{nspp_*} or \code{rls_*}) and taxonomic group or all taxa (\code{*_all}).
#' @source \url{https://github.com/marinebon/bbnj}
#' @source \url{https://aquamaps.org}
#' @source \url{https://iucnredlist.org}
"s_bio_gmbi"

#' Raster stack from Global Fishing Watch analysis of high seas (Sala et al,
#' 2018)
#'
#' Global half-degree raster of high seas. Year of analysis is 2016. See also
#' \url{https://github.com/SFG-UCSB/The-economics-of-fishing-the-high-seas}.
#'
#' @format A \code{\link[raster]{stack}} with layers of results from analyses.
"s_fish_gfw"

#' Raster stack from Sea Around Us Project at UBC (Cheung, Lam et al; in draft) of maximum catch
#' potential
#'
#' Global half-degree raster of high seas. Maximum catch potential (MCP;
#' landings in metric tons) of more than 1,000 fish and invertebrates species
#' for \code{mcp_2004} (average 1995 to 2014) and  \code{mcp_2050} (average 2041 to
#' 2060 under 'business as usual' climate change scenario GFDL 8.5).
#'
#' @format A \code{\link[raster]{stack}} with layers of results from analyses.
"s_fish_saup"

#' Raster stack version 2 from Sea Around Us Project at UBC (Cheung, Lam et al;
#' in draft) of maximum catch potential
#'
#' Global half-degree raster of high seas. Maximum catch potential (MCP;
#' landings in metric tons) of more than 1,000 fish and invertebrates species
#' for \code{mcp_2004} (average 1995 to 2014) and  \code{mcp_2050} (average 2041
#' to 2060 under 'business as usual' climate change scenario GFDL 8.5).
#'
#' Version 2: This pattern along Southeast Pacific in the original version is due to the exceptional
#' high catch potential of Chilean jack mackerel in the upwelling region.
#' Indeed, most of our maps have to adjust by removing this species. Otherwise,
#' the high MCP in this region will mask the MCP of all other areas. I have re-extracted the data for you by
#' removing the MCP of this species. -- Vicky Lam
#'
#' @format A \code{\link[raster]{stack}} with layers of results from analyses.
"s_fish_saup_v2"

#' Stack for count of seamounts (Kim & Wessel, 2011) based on depth bin
#'
#' Global half-degree raster of high seas.
#'
#' @format A \code{\link[raster]{raster}} count of seamount features within cell based on depth of summit:
#' \enumerate{
#'   \item 0 - 200 m; <= 200 m: \code{lteq200m}
#'   \item 200 - 800 m; > 200 & <= 800 m: \code{gt200lteq800m}
#'   \item 800 - Inf m; > 800 m: \code{gt800m}
#' }
"s_phys_seamounts"

#' Raster for count of hydrothermal vents (Interridge Vent Database v3.4)
#'
#' Global half-degree raster of high seas.
#'
#' @format A \code{\link[raster]{raster}} count of hydrothermal vents features within cell.
"r_phys_vents"

#' Raster for presence of mining claim (Interridge Vent Database v3.4)
#'
#' Global half-degree raster of presence in high seas, per ISA_claim_areas_update_20181202.
#'
#' @format A \code{\link[raster]{raster}} presence (1 or 0) of mine claim in cell.
"r_mine_claims"

#' Polygons of mine claims (ISA)
#'
#' Per ISA_claim_areas_update_20181202.
#'
#' @format A \code{\link[sf]{sf}} object of mining claim polygons.
"p_mine_claims"

#' Raster stack for area (km2) of 1 thru 11 classes of benthic seascapes (Harris
#' & Whiteway, 2009)
#'
#' Global half-degree raster of high seas. Original 0.1 deg cells were
#' multiplied by area and summed to 0.5 deg cells.
#'
#' @format A \code{\link[raster]{stack}} in which each layer represents area for given integer class id of benthic seascape corresponding to :
#'  \enumerate{
#'   \item Abyssal, hilly plains, large (arched) uplifted structures, flat abyssal plains, flat, very low PP, very thin sediment (seascape 11)
#'   \item Abyssal, plains with slightly undulating seafloor, flat abyssal plains, continental rise, very flat, high DO, low PP, very cold (seascape 10)
#'   \item Abyssal, flat sedimented plains of marginal seas, central rift zone, ridge flanks, marginal seas with hilly bottoms, flat, low DO, thin sediment (seascape 8)
#'   \item Abyssal, volcanic ridges and highs, central rift zone, ridge flanks, microcontinents, cold (seascape 7)
#'   \item Abyssal (Hadal), trenches controlled by fracture zones, deep water trenches, large arched uplifted structures, low PP thin sediment, cold (seascape 9)
#'   \item Lower Bathyal (Abyssal-Hadal), deep water trenches, island arcs, trenches controlled by fracture zones, volcanic ridges and plateaus, very steep (seascape 6)
#'   \item Lower Bathyal, continental slope see high PP, very thick sediment, warm (seascape 4)
#'   \item Lower Bathyal, other ridges and plateaus, marginal plateaus, marginal seas with hilly bottom, steep, very low DO (seascape 3)
#'   \item Lower Bathyal, deep shelf (submerged), marginal plateaus, very high DO, high PP, thick sediment, warm (seascape 2)
#'   \item Upper Bathyal, shallow shelf, low DO, very high PP. thick sediment very warm (seascape 1)
#'   \item Lower Bathyal, island arcs, steep, high DO (seascape 5)
#' }
#'
#' Note that seascape numbers differ from those in Harris & Whiteway 2009. Numbers in parenthesis correspond to numbers from Harris & Whiteway 2009.
"s_phys_scapes"

#' Raster of heterogeneity of 1 thru 11 classes of benthic seascapes (Harris
#' & Whiteway, 2009)
#'
#' Focal variety, ie number of unique classes, within a 20-cell radius. See \code{\link{s_phys_scapes}}.
#'
"r_phys_scapes_hetero"

#' Raster for average Vertically Generalized Production Model (VGPM)
#'
#' Global half-degree raster of mean primary production using the Vertically
#' Generalized Production Model (Standard VGPM 2013-02-01 to 2019-01-31) using
#' \href{Standard VGPM - 2160 by 4320 Monthly XYZ files from VIIRS
#' Data}{http://orca.science.oregonstate.edu/2160.by.4320.monthly.xyz.vgpm.v.chl.v.sst.php}
#'
#' @format A \code{\link[raster]{raster}} of half-degree cells
"r_vgpm"