read.aqts.locations: Read location data from Aquarius

View source: R/read.aqts.R

read.aqts.locationsR Documentation

Read location data from Aquarius

Description

This function uses the raquarius::GetLocationDescriptionList() function to retrieve location information from the AQTS Publish Service. Setting full_metadata = TRUE will return an sf::st_sf object which will allow easy plotting on a map or spatial filtering.

Usage

read.aqts.locations(..., full_metadata = FALSE)

Arguments

LocationName

Filter results to the given location name

LocationIdentifier

Filter results to given location identifier

TagKeys

Filter results to locations matching all tags by key.

Examples

## Not run: 
# Get a list of all locations
read.aqts.locations()
# Get all locations matching a tag
loc_list <- read.aqts.locations(TagKeys = "PAWMAP")
# Get all metadata for those locations - somewhat slower as each location is a separate API request.
read.aqts.locations(TagKeys = "PAWMAP", full_metadata = TRUE)

## End(Not run)


jasonelaw/BESdata documentation built on June 11, 2025, 5:46 p.m.