Skip to content

Commit

Permalink
Add _poly help; document().
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-edwards committed Nov 8, 2024
1 parent f1ec612 commit 1b99481
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 5 deletions.
19 changes: 17 additions & 2 deletions R/data.R
Original file line number Diff line number Diff line change
Expand Up @@ -826,7 +826,8 @@

#' Polygons masking layers for BC waters
#'
#' Simple features objects of BCCM ROMS data, inshore, and offshore regions of BC Exclusive Economic Zone (EEZ) waters.
#' Simple features objects of BCCM ROMS data, inshore, and offshore regions of
#' BC Exclusive Economic Zone (EEZ) waters, and HOTSSea domain.
#'
#' Bathymetric classifications were used to derive a line to separate continental shelf (inshore) and deep sea regions. Includes a 10km buffer around the EEZ and limited by BCCM data coverage.
#'
Expand All @@ -838,18 +839,25 @@
#' \item{bccm_eez_poly}{BC EEZ boundary witha 10km buffer and clipped with BCCM data output boundary}
#' \item{inshore_poly}{inshore (continental shelf) region of bccm_eez_poly}
#' \item{offshore_poly}{offshore (deep seafloor) region of bccm_eez_poly}
#' \item{hotssea_poly}{HOTSSea domain}
#' \item{bccm_hotssea_poly}{combined full BCCM and HOTSSea domains}
#' }
#' @examples
#' \dontrun{
#' bccm_eez_poly
#' inshore_poly
#' offshore_poly
#' hotssea_poly
#' bccm_hotssea_poly
#' plot(bccm_eez_poly)
#' plot(inshore_poly)
#' plot(offshore_poly)
#' plot(hotssea_poly)
#' plot(bccm_hotssea_poly)
#' }
#'
#' @source Generated from running `data-raw/grids/make-mask-layer.R`.
#' @source Generated from running `data-raw/grids/make-mask-layer.R`,
#' `..../make-mask-layer-hotssea.R`, or `..../make-mask-layer-full.R`
"bccm_eez_poly"

#' @rdname bccm_eez_poly
Expand All @@ -858,6 +866,13 @@
#' @rdname bccm_eez_poly
"offshore_poly"

#' @rdname bccm_eez_poly
"hotssea_poly"

#' @rdname bccm_eez_poly
"bccm_hotssea_poly"


##' Metadata regarding buoys for sea surface temperature.
##'
##' Details regarding the buoys that are used for the data in
Expand Down
22 changes: 20 additions & 2 deletions man/bccm_eez_poly.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion notes/debugging.R
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ passes with no errors.

Trying windows-latest instead of ubuntu-latest in R-CMD-check.yaml. Think it may
have been something to do with the parallel code perhaps (ooh, maybe when
installing the new required packages). That is probably it.
installing the new required packages). Now runs fine on GHA.

0 comments on commit 1b99481

Please sign in to comment.