R/data.R

In alketh/ecocat: Couple ecoham output with Atlantis polygon structure

#' bgm_df
#'
#' bgm file converted to tidy dataframe.
#'
#' @format A data frame with 324 rows and 5 variables:
#' \describe{
#'   \item{\code{lat}}{double. Latitude}
#'   \item{\code{long}}{double. Longitude}
#'   \item{\code{inside_lat}}{double. Latitude of ("mid"-) point inside the polygon.}
#'   \item{\code{inside_long}}{double. Longitude of ("mid"-) point inside the polygon.}
#'   \item{\code{polygon}}{double. Polygonid.}
#' }
"bgm_df"

#' nicemap_df
#'
#' nicemap converted to tidy dataframe.
#'
#' @format A data frame with 7216 rows and 3 variables:
#' \describe{
#'   \item{\code{id_x}}{integer. Horizontal position of the potential ECOHAM box.}
#'   \item{\code{id_y}}{integer. Vertical position of the potential ECOHAM box.}
#'   \item{\code{poly_code}}{character. Value of the box code.}
#'   \item{\code{ecoham_id}}{integer. ECOHAM box id.}
#'   \item{\code{polygon}}{double. ATLANTIS polygon id.}
#' }
"nicemap_df"

#' ecoham_layout
#'
#' mid points in latitude and longitude for each ecoham box.
#'
#' @format A data frame with 7216 rows and 3 variables:
#' \describe{
#'   \item{\code{longitude}}{double. longitude.}
#'   \item{\code{latitude}}{double. latitude.}
#'   \item{\code{ecoham_id}}{integer. ECOHAM box id.}
#'   \item{\code{area}}{double. grid area in square meters.}
#' }
"ecoham_layout"

#' Reference dataframe for volume per ecoham grid.
#'
#' Volume in m^3 for each ECOHAM grid and depth layer.
#'
#' @format A data frame with 8819 rows and 3 variables:
#' \describe{
#'   \item{\code{depth}}{double. depth:units = "meters".}
#'   \item{\code{ecoham_out}}{double. vol:units = "m3".}
#'   \item{\code{ecoham_id}}{integer. grid cell.}
#' }
"ecoham_vol"

#' Cumulative sum of nominal_dz from GNS-Atlantis model.
#'
#' Cumulative nominal_dz.
#'
#' @format A data frame with 95 rows and 3 variables:
#' \describe{
#'   \item{\code{polygon}}{integer. ATLANTIS polygon.}
#'   \item{\code{layer}}{double. ATLANTIS layer.}
#'   \item{\code{max_nominal_dz}}{double. maximum cimulative nominal_dz per polygon and layer.}
#' }
"nominal_dz_df"


#' Unique combination between ATLANTIS polygons and ECOHAM mean depths.
#'
#' Polygons and depths.
#'
#' @format A data frame with 40 rows and 2 variables:
#' \describe{
#'   \item{\code{depth}}{double. mean depth of ECOHAM grid cells.}
#'   \item{\code{polygon}}{double. ATLANTIS polygon ids.}
#' }
"poly_depth_df"