| Title: | Mapping Utilities for The Pacific Ocean |
|---|---|
| Description: | This package provides objects and functions for making plots and maps easier to create in the Pacific Ocean. |
| Authors: | Devin S. Johnson |
| Maintainer: | Devin S. Johnson <[email protected]> |
| License: | CC0 |
| Version: | 0.1.9011 |
| Built: | 2025-01-28 17:19:17 UTC |
| Source: | https://github.com/PIFSC-Protected-Species-Division/picMaps |
This package is a collection of functions that helps gather spatial data for creating maps in the Pacific Ocean.
| Package: | picMaps |
| Version: | 0.1.9011 |
| Date: | January 27, 2025 |
| License: | CC0 |
| LazyLoad: | yes |
This software package is developed and maintained by scientists at the NOAA Fisheries Pacific Islands Fisheries Science Center and should be considered a fundamental research communication. The recommendations and conclusions presented here are those of the authors and this software should not be construed as official communication by NMFS, NOAA, or the U.S. Dept. of Commerce. In addition, reference to trade names does not imply endorsement by the National Marine Fisheries Service, NOAA. While the best efforts have been made to insure the highest quality, tools such as this are under constant development and are subject to change.
Devin S. Johnson <[email protected]> (Maintainer)
Downloads bathymetery data for map making.
etopo_download(resolution = 60, force = FALSE)etopo_download(resolution = 60, force = FALSE)
resolution |
numeric resolution in arcsecs (one of 30, or 60). Defaults to 60 arcsecs. |
force |
Logical. If data has previously been downloaded, it will force a new download and update of the OSM data. |
Devin S. Johnson
https://osmdata.openstreetmap.de/data/land-polygons.html
The majority of this function is taken from the topotools package here: https://github.com/BigelowLab/topotools/tree/main. It was modified to work within
the 'picMaps' package.
etopo_rast(x, resolution = 60, proj = TRUE, ...)etopo_rast(x, resolution = 60, proj = TRUE, ...)
x |
an |
resolution |
Resolution of the ETOPO bathymetry raster, either |
proj |
Logical. Should the resulting raster be projected to the same CRS as |
... |
Addtional arguments passed to |
NOAA National Centers for Environmental Information. 2022: ETOPO 2022 15 Arc-Second Global Relief Model. NOAA National Centers for Environmental Information. DOI: 10.25921/fd45-gt74. Accessed 2023-03-17.
This function provides the location where 'picMaps' is storing and retrieving spatial data.
get_data_loc()get_data_loc()
Coast polygons for Main Hawaiian Islands
hawaii_coast(keep = 0.5, union = TRUE, crs = 4326)hawaii_coast(keep = 0.5, union = TRUE, crs = 4326)
keep |
see |
union |
see |
crs |
A coordinate system object, See |
Hawaiian Island EEZ boundary polygon
hawaii_eez()hawaii_eez()
Calculates the appropriate cellsize argument for making
a hexagon grid with st_make_grid.
hex_size(area = NULL, radius = NULL, sep = NULL)hex_size(area = NULL, radius = NULL, sep = NULL)
area |
A value (m^2) for the resulting area of a full hexagon cell |
radius |
The value for the distance (m) from the centroids to the edge of full hexagon cells. |
sep |
The distance (m) between centoids of the hexagon grid. |
Devin S. Johnson
See https://github.com/r-spatial/sf/issues/1505
Coast polygons for the Mariana Islands
mariana_coast(keep = 0.5, union = TRUE, crs = 4326)mariana_coast(keep = 0.5, union = TRUE, crs = 4326)
keep |
see |
union |
see |
crs |
A coordinate system object, See |
Mariana Islands US EEZ boundary polygon
mariana_eez()mariana_eez()
sf Polygon Object For Plotting and MappingUses downloaded OSM data for constructing an sf polygon coastline data object.
Prior to using this function you must run osm_download.
osm_coast(x, keep = 0.2, union = FALSE)osm_coast(x, keep = 0.2, union = FALSE)
x |
An |
keep |
The amount of data retained after simplification with |
union |
Logical. Should the returned object be returned as a single |
Josh M. London and Devin S. Johnson
Downloads OSM data for plotting telemetry data and use distributions.
osm_download(force = FALSE, clean_shp = TRUE)osm_download(force = FALSE, clean_shp = TRUE)
force |
Logical. If data has previously been downloaded, it will force a new download and update of the OSM data. |
clean_shp |
Logical. If 'TRUE' the original shape file will be deleted and only the '.gpkg' file will be retained. |
Devin S. Johnson and Josh M. London
https://osmdata.openstreetmap.de/data/land-polygons.html
Downloads OSM data for plotting telemetry data and use distributions.
osm_install(zip_file, force = FALSE, clean_shp = TRUE)osm_install(zip_file, force = FALSE, clean_shp = TRUE)
zip_file |
path to the OSM data .zip file 'land-polygons-complete-4326.zip'. If left unspecified, the user will see a directory browser to navigate to it. See the url in the references to download it by hand. Also, see 'osm_download' to download and install it. |
force |
Logical. If data has previously been downloaded or installed, it will force a new install and update of the OSM data. |
clean_shp |
Logical. If 'TRUE' the original shape file will be deleted and only the '.gpkg' file will be retained. |
Devin S. Johnson and Josh M. London
Get information here: https://osmdata.openstreetmap.de/data/land-polygons.html and download with this link https://osmdata.openstreetmap.de/download/land-polygons-complete-4326.zip
Papahānaumokuākea boundary polygon
papahanaumokuakea()papahanaumokuakea()
The directory specified by path will be used to store downloaded spatial data. By storing the
data in a separate directory from the installed package it will not need to be re-downloaded when the package
is updated. You simply need to rerun this function to let the package functions know where the data is located.
set_data_storage(path = "~/.picmaps_data")set_data_storage(path = "~/.picmaps_data")
path |
A directory path specifying where spatial data will be stored for the package |
sf::st_bbox for a list of sf or sfc objects.sf::st_bbox for a list of sf or sfc objects.
st_bbox_list(x, union = TRUE, as_sfc = FALSE)st_bbox_list(x, union = TRUE, as_sfc = FALSE)
x |
A list of |
union |
Logical. Should the bounding box of the union be returned instead of a list of bounding boxes. |
as_sfc |
Logical. Should the bounding box (boxes) be returned as |
Devin S. Johnson
Expand an sf bounding box by an expansion factor
st_expand(bbox, ef)st_expand(bbox, ef)
bbox |
An |
ef |
Expansion factor, must be positive and length 1, 2 or 4.
If |
Josh M. London
Predicate function to use with st_filter such that
such that elements of one spatial object are selected if
they are not contained at all in the other. See sf::st_within
st_not_within(x, y, sparse = TRUE, prepared = TRUE, ...)st_not_within(x, y, sparse = TRUE, prepared = TRUE, ...)
x |
object of class sf, sfc or sfg |
y |
object of class sf, sfc or sfg; if missing, x is used |
sparse |
ogical; should a sparse index list be returned (TRUE) or a dense logical matrix? See sf::st_within. |
prepared |
ogical; prepare geometry for x, before looping over y? See sf::st_within. |
... |
passed on to s2_options |
sf::st_union for a list of sf or sfc objects.sf::st_union for a list of sf or sfc objects.
st_union_list(x)st_union_list(x)
x |
A list of |
Devin S. Johnson