osbng (version 0.2.0)

list_bng: List the components of the British National Grid

Description

Helper functions to provide access to the bounds and set of 100km grid reference identifiers.

Usage

list_bng_prefixes(arranged = FALSE)
list_bng_bounds(named = TRUE)

Value

a character vector of 2-letter identifiers for all valid 100km grid squares. When arranged is TRUE this vector is coerced into a 2D matrix.

a numeric vector with four values for the xmin, ymin, xmax, and ymax coordinates for the valid extant of the British National Grid.

Arguments

arranged

logical. Should the grid reference letters be arranged into a 2D matrix? Default is FALSE.

named

logical. Should the bounding box vector include the names (e.g. 'xmin')? Default is TRUE.

Details

When arranged is TRUE, the matrix arrangement matches the British National Grid, but note the orientation. The first element "SV" would be mapped in the southwest corner.

Examples

list_bng_prefixes()

list_bng_prefixes(arranged = TRUE)

list_bng_bounds()