s2polygon: Create a s2polygon

View source: R/s2region.R

s2polygonR Documentation

Create a s2polygon

Description

Create a s2polygon (object of class "s2polygon").

Usage

s2polygon(x, ..., oriented = FALSE, check = TRUE, options = NULL)

Arguments

x

List of loops (also called rings) to join as a polygon.

...

Arguments passed on to s2

radius

Numeric. Defaults to 1. For convenience this can also be an object of class "s2region" from where the radius and unitname then will be extracted.

unitname

Optional. Name of unit of length. Either a single character string, or a vector of two character strings giving the singular and plural forms, respectively.

oriented

logical, which defaults to FALSE. Set to TRUE if polygon ring directions are known to be correct such that exterior rings are counter clockwise and interior rings are clockwise.

check

logical, which defaults to TRUE. Throws an error if the polygon is invalid.

options

List of class "s2_options" to control how the polygon is assembled. See s2::s2_options() for available options and details.


spatstat/spatstat.sphere documentation built on Jan. 27, 2023, 2:59 a.m.