s2 (version 1.0.0)

as_s2_geography: Create an S2 Geography Vector

Description

Geography vectors are arrays of points, lines, polygons, and/or collections of these. Geography vectors assume coordinates are longitude and latitude on a perfect sphere.

Usage

as_s2_geography(x, ...)

# S3 method for default as_s2_geography(x, ...)

# S3 method for s2_geography as_s2_geography(x, ...)

# S3 method for s2_latlng as_s2_geography(x, ...)

# S3 method for s2_point as_s2_geography(x, ...)

# S3 method for wk_wkb as_s2_geography(x, ..., oriented = FALSE, check = TRUE)

# S3 method for WKB as_s2_geography(x, ..., oriented = FALSE, check = TRUE)

# S3 method for blob as_s2_geography(x, ..., oriented = FALSE, check = TRUE)

# S3 method for wk_wkt as_s2_geography(x, ..., oriented = FALSE, check = TRUE)

# S3 method for character as_s2_geography(x, ..., oriented = FALSE, check = TRUE)

# S3 method for logical as_s2_geography(x, ...)

# S3 method for s2_geography as_wkb(x, ..., endian = wk::wk_platform_endian())

# S3 method for s2_geography as_wkt(x, ..., precision = 16, trim = TRUE)

Arguments

x

An object that can be converted to an s2_geography vector

...

Unused

oriented

TRUE if polygon ring directions are known to be correct (i.e., exterior rings are defined counter clockwise and interior rings are defined clockwise).

check

Use check = FALSE to error on invalid geometries

endian

The endian to use when writing well-known binary. Defaults to the platform endian. See wk::as_wkb().

precision

The number of significant digits to export when writing well-known text. If trim = FALSE, the number of digits after the decimal place.

trim

Should trailing zeroes be included after the decimal place?

Value

An object with class s2_geography

Details

The coercion function as_s2_geography() is used to wrap the input of most functions in the s2 package so that you can use other objects with an unambiguious interpretation as a geography vector. Geography vectors have a minimal vctrs implementation, so you can use these objects in tibble::tibble() and other packages that use the vctrs framework.

See Also

s2_geog_from_wkb(), s2_geog_from_text(), s2_geog_point(), s2_make_line(), s2_make_polygon() for other ways to create geography vectors, and s2_as_binary() and s2_as_text() for other ways to export them.