calculate_cell_size {geogrid}

Calculate size of grid items (deprecated).

Description

Given an input multipolgyon spatial data frame this function calculates the required cell size of a regular or hexagonal grid.

Usage

calculate_cell_size(
  shape,
  shape_details = NULL,
  learning_rate = 0.03,
  grid_type = c("hexagonal", "regular"),
  seed = NULL,
  verbose = FALSE
)

Arguments

shape

A 'SpatialPolygonsDataFrame' object representing the original spatial polygons.

shape_details

deprecated.

learning_rate

The rate at which the gradient descent finds the optimum cellsize to ensure that your gridded points fit within the outer boundary of the input polygons.

grid_type

Either 'hexagonal' for a hexagonal grid (default) or 'regular' for a regular grid.

seed

An optional random seed integer to be used for the grid calculation algorithm.

verbose

A logical indicating whether messages should be printed as the algorithm iterates.