stamp.stgroup.summary {stampr}

Compile stamp summary statistics by space-time group

Description

The function stamp.stgroup.summary compiles summary statistics for each STAMP space-time grouping. Specifically, it computes the area of each STAMP event type (e.g., generation, expansion, etc.) within each grouping. It also computes the number of events belonging to each event type.

Usage

stamp.stgroup.summary(stmp, area = TRUE, count = TRUE)

Arguments

stmp

a sf polygon object generated from the stamp.multichange function.

area

logical, whether or not to compute the STAMP event areas.

count

logical, whether or not to compute the count of STAMP events within each group.

Details

stamp.stgroup.summary computes area and count summary statistics of STAMP output derived from multi-time analysis using stamp.multichange. stamp.multichange is just a wrapper function for applying stamp to multiple time periods in the same dataset. Note that if both area and count are set to FALSE, stamp.stgroup.summary returns a data.frame with just the stgroup IDs as the only column.

Value

A data.frame where rows are stamp groups and columns correspond to the STAMP event types (ID, areas, and counts).

See Also

stamp.multichange

Examples

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

## End(Not run)