stamp.stgroup.summary: Compile stamp summary statistics by space-time group

Description Usage Arguments Details Value Examples

View source: R/stamp.stgroup.summary.r

Description

The function stamp.stgroup.summary compiles summary statistics for each STAMP 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

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

Arguments

stmp

a SpatialPolygonsDataFrame generated from the stamp function.

area

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

count

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

Details

stamp.group.summary computes area and count summary statistics of STAMP output. Note that if both area and count are set to FALSE, stamp.group.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).

Examples

1
2
3
4
5
6
library(sp)
data("katrina")
katrina$ID <- katrina$Id
ch <- stamp.multichange(katrina, changeByRow = TRUE, dc = 0, distance = TRUE, direction = FALSE)
STGroup <- stamp.stgroup.summary(ch)
head(STGroup)

colinr23/stampr documentation built on April 18, 2018, 9:29 p.m.