Skip to contents

Create a grid with st_make_grid_ext() and

Usage

make_sf_grid_list(
  x,
  style = "rect",
  ncol = 2,
  nrow = 2,
  .id = "grid_id",
  crs = NULL,
  ...
)

Arguments

x

A sf, sfc, or bbox object, Default: NULL. Required.

style

Style of cell to return with options including "rect", "square", "hex", "flat_top_hex", "circle", "circle_offset"

ncol, nrow

Used to set n if either are not NULL; defaults to NULL. row and id are added as columns to the grid if they are provided.

.id

A name to use for the cell id column. Defaults to "id".

crs

Coordinate reference system of bounding box to return; defaults to NULL which maintains the crs of the input object.

...

Arguments passed on to st_make_grid_ext

ncol,nrow

Used to set n if either are not NULL; defaults to NULL. row and id are added as columns to the grid if they are provided.

gutter

Distance in units between each column cell; gutter effectively serves as a margin as the negative buffer is applied to all cells (including those at the edges of the grid).

desc

If TRUE, reverse standard order of cell id numbering; defaults FALSE

n

If n is NULL and square is TRUE, the grid is set automatically to be 10 cells wide, Default: NULL

what

"polygons", "corners", "centers"; set to centers automatically if style is "circle", "circle_offset" but a buffer is applied to return circular polygons.

filter

If TRUE (or if trim is TRUE) filter grid geometry by x using st_filter_ext

unit

Units for buffer. Supported options include "meter", "foot", "kilometer", and "mile", "nautical mile" Common abbreviations (e.g. "km" instead of "kilometer") are also supported. Distance in units is converted to units matching GDAL units for x; defaults to "meter"

cellsize

numeric of length 1 or 2 with target cellsize: for square or rectangular cells the width and height, for hexagonal cells the distance between opposite edges (edge length is cellsize/sqrt(3)). A length units object can be passed, or an area unit object with area size of the square or hexagonal cell.

trim

If TRUE, x is trimmed to y with st_trim().