Package {sds}

sds: Spatial Data Sources

Description

Descriptions of spatial data sources that can be read directly with or without download. Most sources are readable by 'GDAL' software. There are functions for imagery, elevation, and a variety of easily accessible data streams including image tile servers, links to online files, and geographic data services.

Author(s)

Maintainer: Michael Sumner mdsumner@gmail.com [copyright holder]

Authors:

• Michael Sumner mdsumner@gmail.com [copyright holder]

See Also

Useful links:

• https://github.com/hypertidy/sds

• Report bugs at https://github.com/hypertidy/sds/issues

the geoBoundaries countries

Description

CGAZ() returns the DSN, a shapefile of geo boundaries, CGAZ_sql() returns SQL suitable for use with GDAL, for the names or codes of countries.

Usage

CGAZ(old = FALSE)

CGAZ_sql(codes)

Arguments

Value

character string; CGAZ() returns a GDAL data source name and CGAZ_sql() returns an SQL query string

Examples

CGAZ_sql(c("Australia", "New Zealand"))
CGAZ_sql(c("AUS", "NZL"))
## do something like gdal_raster_data(gebco(), target_res = 1,
##                                        options = c("-crop_to_cutline",
##                                        "-cutline", CGAZ(),
##                                         "-csql", CGAZ_sql(c("Australia", "New Zealand")) ))

Medium resolution vector polygons of Antarctic rock outcrop - VERSION 7.3

Description

https://data.bas.ac.uk/full-record.php?id=GB/NERC/BAS/PDC/01409

Usage

addrock()

Value

character string, a GDAL data source name for the Antarctic rock outcrop polygons

Examples

addrock()

DEA 250m dem (superseded)

Description

Australian Bathymetry and Topography 2023 250m MSL 'COG' (AusSeabed). This source is dead: the 2023 S3 object was removed when it was superseded by AusBathyTopo 250m 2024 (doi:10.26186/150050). Calling this function errors with that successor information.

Usage

dea_250m_dem(vsi = TRUE)

Arguments

Value

errors; the source is superseded (see Description)

Data source name for a named spatial data source

Description

Look up a source by name in the sds registry and return a GDAL-ready data source name (DSN). The registry records the kind of every source, so the returned string is fully dressed: '/vsicurl/' for online rasters and Parquet, '/vsizip//vsicurl/' for zipped vector sources, complete 'WMTS:' connection strings for tile services, and full XML or VRT text for sources that are recipes rather than URLs.

Usage

dsn(name)

Arguments

Details

There is deliberately no prefix toggle. If you want the bare URL, take it from the 'url' column of dsn_list(), or unchain with dsn::unvsicurl(). To chain further, compose with dsn verbs or the 'vrt://' protocol, for example 'paste0("vrt://", dsn("esri_world_imagery"), "?ovr=12")'.

Value

character vector of GDAL data source names, same length as 'name'

Examples

dsn("gebco25")
dsn(c("cop30", "nasa_antarctic_modis"))
dsn_list(theme = "bathymetry")$name

Imagery online sources

Description

Raster and imagery online

Usage

wms_arcgis_mapserver_ESRI.WorldImagery_tms()

wms_bluemarble_s3_tms()

wms_googlehybrid_tms()

wms_virtualearth()

wms_ESA_worldcover_2020_tms()

wms_mapbox_satellite()

wms_amazon_elevation()

wms_mapbox_terrain()

wms_openstreetmap_tms()

wms_googleterrainstreets_tms()

wms_virtualearth_street()

wms_arcgis_mapserver_tms()

nasadem()

cop90()

cop30()

srtm15()

Value

character string, a GDAL data source name (a 'GDAL_WMS' XML description or a '/vsicurl/' URL)

Examples

cop30()
wms_openstreetmap_tms()

List and filter the sds registry

Description

Returns the registry as a data frame, optionally filtered. This is the discovery surface: themes, providers, kinds, licenses, and liveness status are all columns you can inspect.

Usage

dsn_list(pattern = NULL, theme = NULL, provider = NULL, kind = NULL)

dsn_info(name)

Arguments

Value

data frame, one row per source

Examples

dsn_list(theme = "bathymetry")
dsn_list(provider = "nasa_gibs")
dsn_list("antarctic")

ESACCI chlorophyll-a in monthly

Description

ESACCI chlorophyll-a in monthly

Usage

esacci_chlor_a(time.resolution = "monthly")

Arguments

Value

data frame with date,source

Examples

dsn <- esacci_chlor_a()

GADM administrative boundaries

Description

GADM 4.1 whole-planet administrative areas as GeoParquet, hosted as an sds release asset. The original single GeoPackage from geodata.ucdavis.edu is available as dsn("gadm_gpkg"). GADM data is free for academic and non-commercial use only, see gadm.org/license.

Usage

gadm(vsi = TRUE)

Arguments

Value

data source name for GADM 4.1 GeoParquet

Examples

gadm()

GEBCO source dsn

Description

A data source name to the GEBCO elevation 'COG' GeoTIFF.

Usage

gebco(vsi = TRUE)

gebco26(vsi = TRUE)

gebco25(vsi = TRUE)

gebco24(vsi = TRUE)

gebco21(vsi = TRUE)

gebco23_bedrock(vsi = TRUE)

gebco23(vsi = TRUE)

gebco22(vsi = TRUE)

gebco19(vsi = TRUE)

Arguments

Details

GEBCO 2023 and 2022 is created and hosted by Philippe Massicotte.

GEBCO 2019 and 2021 created and hosted by the Australian Antarctic Division, served via the AADC data API (data.aad.gov.au/eds/api).

See note about which forms of the bedrock vs ice surface are available. Generally we use the ice surface form, because that is what encountered while navigating the surface of the Earth. But, the bedrock is of course also of interest. "If the data sets are used in a presentation or publication then we ask that you acknowledge the source. This should be of the form (see references)."

Value

character string, URL to online GeoTIFF

warning

please note that gebco21(), gebco19(), gebco24(), gebco25() and gebco26() return the ice surface form, while gebco22() returns the bedrock form. With gebco23() and gebco23_bedrock(), thanks to Philippe Massicotte.

References

https://www.gebco.net/data-products/gridded-bathymetry-data 'GEBCO Compilation Group (2025) GEBCO 2025 Grid (doi:10.5285/37c52e96-24ea-67ce-e063-7086abc05f29)'

GEBCO 2026, 2025 and 2024 are hosted on Source Cooperative by the Australian Antarctic Division.

Examples

gebco()

GHRSST files, GeoTIFFs on source.coop

Description

GHRSST files, GeoTIFFs on source.coop

Usage

ghrsst(vsi = TRUE)

Arguments

Value

dataframe of source,date

Examples

files <- ghrsst()
tail(files$source)

IBCOS source dsn

Description

A data source name to the IBCSO elevation 'COG' GeoTIFF.

Usage

ibcso(vsi = TRUE, chart = FALSE)

Arguments

Details

Currently at v2.

Value

character string, URL to online raster

Examples

ibcso()

Tasmania theLIST address query

Description

Build a query URI for the Tasmanian theLIST address service.

Usage

list_address(address)

Arguments

Value

string URI for List service

Examples

list_address(c(2862, "LYELL", "HAYES"))

Cadastral parcel source

Description

Cadastral parcel source

Usage

list_parcel_shp()

Value

string URI for List shapefile

Examples

list_parcel_shp()  ## read with terra::vect( ) or new(gdalraster::GDALVector, )

Mapterhorn PMTiles raster elevation

Description

Rendered calc VRT that unpacks planet.pmtiles from Mapterhorn, a large collection of regional elevation sources encoded in Terrarium Terrain RGB '(R*256 + G + B/256) - 32768'

Usage

mapterhorn_elevation(...)

Arguments

Value

VRT text string, useable by GDAL >= 3.14 with muparser support

Examples

writeLines(mapterhorn_elevation())

Microsoft Planetary Computer

Description

Function mpc() will return a full data source name for a Spatio-Temporal Asset Catalog ('STAC').

Usage

mpc(
  collection = "sentinel-2-l2a",
  bbox = "146.5,-43.2,147.5,-42.2",
  datetime = Sys.Date() + c(-5, 1),
  asset = "",
  stacit = TRUE
)

Arguments

Details

Each argument has a default, use them to set the collection, datetime range, bounding box, and asset.

If no asset is specfied the description is a complex source composed of multiple subdatasets ('GDAL' terminology). In a 'STAC' context "asset" and "subdataset" are synonomous for 'GDAL'.

Value

a string, a data source name for 'GDAL'

Examples

mpc()

## we can be more general than GDAL, and say do a query to get Parquet for MS Buildings

mpc(collection = "ms-buildings", stacit = FALSE, bbox = "140,-45,145,-30",
                                 datetime = as.Date("2000-01-01"))
## read that url with jsonlite and investigate $features$assets$data$href
## but it's all abfs:// azure special links

MURSST (GHRSST) sst Zarr source

Description

This is used a lot of noisy fanfare about why everyone must move to Zarr in the cloud. It's really big, daily netcdf blended/observation/model data on a 36000x18000 grid, a regular grid in -180, 180, -90, 90.

Usage

mursst_zarr(band = 0)

mursst_time(time = NULL)

Arguments

Details

This zarr and every other one I've found is unuseably out of date. It seems like this source doesn't go past "2020-01-21" or band 6443, don't know why that is.

Value

a string, a dsn for Zarr MURSST

Examples

mursst_zarr()
mursst_time("2019-10-08")

Data sources for NOAA NSIDC GeoTIFF images for sea ice concentration and extent.

Description

Data is colour-palette GeoTIFF in polar stereographic raster format.

Usage

nsidc_seaice(
  date,
  hemisphere = c("south", "north"),
  temporal = c("daily", "monthly"),
  varname = c("concentration", "extent"),
  vsi = TRUE
)

Arguments

Details

The availability of the date is not checked currently, the minimum date is 1978-10-26. Please note that these data were only every two days from date, until a later time (FIXME get these details).

Value

character string, GDAL readable DSN to a colour palette GeoTIFF (see args 'vsi' and others for options)

Examples

nsidc_seaice("2023-06-27")

REMA reference elevation model of Antarctica

Description

This is a single description string for all of the 2m REMA. The VRT is crafted with efficient overviews so is much more performant with the warper API than other existing descriptions.

Usage

rema()

rema_v2()

Details

See rema-ovr for examples.

Value

character string, GDAL-readable raster data source name

Examples

rema()

Sea ice CDR (climate data record) url

Description

The first subdataset 'cdr_seaice_conc' is the one you want, but also included are "cdr_seaice_conc_interp_spatial_flag", "cdr_seaice_conc_interp_temporal_flag", "cdr_seaice_conc_qa_flag", "cdr_seaice_conc_stdev", "raw_bt_seaice_conc", "raw_nt_seaice_conc" and "surface_type_mask"

Usage

seaice_cdr(date, hemisphere = c("south", "north"), vsi = TRUE)

Arguments

Details

I've had mixed success setting subdataset and having these return with the correct orientation.

Value

string with path to CDR sea ice netcdf file

Examples

seaice_cdr()

Sentinel 2 WMS

Description

To use this you must have your own "INSTANCE_ID", set this in env var "SENTINELHUB_INSTANCE_ID".

Usage

sentinel2_wms(
  layer = c("TRUE-COLOR-S2L2A", "NDVI", "FALSE-COLOR", "FALSE-COLOR-URBAN",
    "AGRICULTURE", "BATHYMETRIC", "GEOLOGY", "MOISTURE-INDEX", "SWIR", "NATURAL-COLOR"),
  datetime = NA
)

Arguments

Value

a string to a WMS

Examples

sentinel2_wms()

Sentinel-2 MGRS tile grid

Description

The Sentinel-2 (MGRS 100km) tiling grid, one row per tile with native UTM extent and longitude/latitude extent, used by stacit() to resolve a 5-character MGRS square designator (e.g. "55GEP") to a query extent.

Usage

sentinel_grid

Format

A data frame with 56686 rows and 15 columns:

land

logical, tile intersects land

xmin,xmax,ymin,ymax

numeric, tile extent in native UTM

crs

character, native UTM crs e.g. "EPSG:32701"

zone

character, UTM zone "01".."60"

latband

character, MGRS latitude band letter

lonband

character, MGRS 100km column/row pair

antim_wrap

logical, tile crosses the anti-meridian in longlat

hemisphere

character, "north" or "south"

ll_xmin,ll_ymin,ll_xmax,ll_ymax

numeric, tile extent in longlat

Source

Derived from the ESA Sentinel-2 tiling grid KML, see data-raw/sentinel-grid.R

STAC Query URL Generator

Description

Generate STAC API search URLs from an extent and date specification. Provides a simple interface for constructing valid STAC queries without manually assembling URL parameters.

Usage

stacit(
  extent,
  date = "",
  collections = "sentinel-2-c1-l2a",
  provider = c("https://earth-search.aws.element84.com/v1/search",
    "https://planetarycomputer.microsoft.com/api/stac/v1/search"),
  gdal_stacit = FALSE,
  limit = 300
)

Arguments

Value

Character vector of STAC search URL(s). Returns multiple URLs when the extent crosses the anti-meridian.

Extent specification

The extent can be specified as either:

• A numeric vector of length 4 giving xmin, xmax, ymin, ymax in longitude/latitude (EPSG:4326)

• A character string giving a 100km MGRS grid square code (e.g. "43DFD")

Extents that cross the anti-meridian (i.e. where xmin < -180 or xmax > 180) are automatically split into two queries, one for each side of the ±180° boundary. This handles the case where a projected extent (e.g. UTM) spans the anti-meridian but STAC APIs truncate bounding boxes at -180/180.

Date specification

The date parameter accepts flexible input formats that are expanded to ISO 8601 datetime intervals:

• Year only: "2024" becomes ⁠2024-01-01T00:00:00Z/2024-12-31T23:59:59Z⁠

• Year-month: "2024-06" expands to the full month interval

• Full date: "2024-06-15" expands to that single day

• Date range: c("2024-01-01", "2024-01-31") for explicit start/end

• Date or POSIXt objects are also accepted

References

STAC API specification: https://github.com/radiantearth/stac-api-spec

GDAL STACIT driver: https://gdal.org/en/stable/drivers/raster/stacit.html

See Also

mpc() for Microsoft Planetary Computer catalog access; sentinel2_wms() for Sentinel-2 WMS layer construction

Examples

# Simple bounding box query for today
stacit(c(140, 145, -43, -40))

# MGRS grid square for a specific month
stacit("43DFD", date = "2025-01")

# Date range query
stacit(c(140, 145, -43, -40), date = c("2024-06-01", "2024-06-30"))

# Anti-meridian crossing returns two queries
stacit(c(179, 181, -16, -15), date = "2024-03")

# Use Planetary Computer instead of Earth Search
stacit(c(140, 145, -43, -40),
       provider = "https://planetarycomputer.microsoft.com/api/stac/v1/search")

# Query Landsat collection
stacit(c(140, 145, -43, -40), collections = "landsat-c2-l2", date = "2024")

Tasmania DEM (2m)

Description

by MRT 2021

Usage

tas_dem(vsicurl = TRUE)

Arguments

Value

data source name for Tasmania 2m DEM

Examples

tas_dem()

USGS seamless DEM

Description

USGS seamless DEM

Usage

usgs_seamless(vsicurl = TRUE)

Arguments

Value

character string, a GDAL data source name for the USGS seamless DEM

Examples

usgs_seamless()