list_ngd_collections: Retrieve OS NGD Feature Collections

In osdatahub: Easier Interaction with the Ordnance Survey Data Hub

Retrieve OS NGD Feature Collections

Description

Query the osdatahub NGD Features API to gather information on available data collections. An API key is not required for this query.

Usage

list_ngd_collections(simple = TRUE)

Arguments

simple

(logical) Should only the collection ID be returned? Default is TRUE. Use FALSE to return the detailed output.

Details

OS NGD themes and collections have been created to group similar geographic entities and data types, making it quicker and easier to identify the data you need. The OGC API - Features standard also references feature collections, and in the context of OS NGD datasets, this is equivalent to feature types. The following naming convention has been applied to the feature collections: theme-collection-featuretype. Short codes have been used for both the theme and collection to keep the feature collection names manageable and not overly long. An example of the short codes used is: 'bld-fts-buildingline'. For more information, see https://osdatahub.os.uk/docs/ofa/technicalSpecification.

Value

If simple is TRUE then return a character vector of available collections identified by their shortened code, else return a data.frame with the full details.

Examples

ngd_collections <- list_ngd_collections(simple = TRUE)
ngd_collections[1:10]

osdatahub documentation built on April 11, 2025, 5:52 p.m.