stamp.multichange: run stamp function for multiple years of polygons at once

View source: R/stamp.multichange.r

stamp.multichangeR Documentation

run stamp function for multiple years of polygons at once

Description

The function stamp.multichange is a wrapper function that makes multiple calls to the stamp function to ease spatial-temporal analysis of multiple years of polygon data

Usage

stamp.multichange(polys, changeByRow = TRUE, changeField = "", ...)

Arguments

polys

a sf polygon object with 2+ years of data to run through the stamp function.

changeByRow

logical, whether or not each time period is a separate unique row of data (e.g., as per the katrina data)

changeField

string, name of the field which contains time period if changeByRow is FALSE

...

list of paramater values to provide to the stamp function

Details

stamp.multichange is a simple wrapper function for the stamp function. The two options for data structure are those in the katrina data, where each time period is a row, and rows are time-ordered, and the structure of the mpb data, where time period is specified by a column. Time periods should be ordered from 1 through T.

Value

A sf object which includes all outputs from the calls to the stamp function. If there are T time periods, there will be T-1 time periods in the resulting sf object.

See Also

stamp.stgroup.summary

Examples

## Not run: 
## NOT RUN ##
data("katrina")
ch <- stamp.multichange(katrina, changeByRow = TRUE, dc = 0, distance = TRUE, direction = FALSE)
STGroup <- stamp.stgroup.summary(ch)
head(STGroup)

## End(Not run)

stampr documentation built on April 28, 2023, 1:10 a.m.