FSS: Forward Scan Statistic

Description Usage Arguments Value Author(s) Examples

View source: R/FindSummaryStats.R

Description

Perform a forward scan statistic analysis.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
FSS(data_xyt, num1Slice, num1Period, numPeriods, numX,
                 numY, plotIte = 6, cellIndices = NULL, data_poly =
                 NULL, maxSum = 3, tempSmooth = TRUE, spatSmooth =
                 TRUE, alpha = 0.7, lambda = 0.8, num1Day = 1,
                 dspSlices = NULL, fillThreshold = 1, colPoints =
                 "green", colA = "red", colB = "orange", colP =
                 "green")

## Default S3 method:
FSS(data_xyt, num1Slice, num1Period, numPeriods, numX,
                 numY, plotIte = 6, cellIndices = NULL, data_poly =
                 NULL, maxSum = 3, tempSmooth = TRUE, spatSmooth =
                 TRUE, alpha = 0.7, lambda = 0.8, num1Day = 1,
                 dspSlices = NULL, fillThreshold = 1, colPoints =
                 "green", colA = "red", colB = "orange", colP =
                 "green")

Arguments

data_xyt

a spatial-temporal point process data frame.

num1Slice

number of time points in one slice.

num1Period

number of slices in one period.

numX

number of cells on the x-axis.

numY

number of cells on the y-axis.

tempSmooth

logical. Whether or not apply a temporal smoothing to the data.

spatSmooth

logical. Whether or not apply a spatial smoothing to the data.

alpha

value of the temporal smoother.

lambda

value of the spatial smoother.

num1Day

number of time points per day.

...

Additional parameters.

Value

An object of class list, including elements

xy

original point process.

poly

polygon of the spatial area (if specified).

Obs

transformed data to feed in the algorithm.

cells

cells of interest (if specified).

inputArgs

list of the input arguments.

originalSlices

cell-repartition of the data.

smoothedSlices

smoothed cell repartition of the data.

partResults

dataframe of all the iterations of the algorithm, with the partitioning decision and the offsprings.

colors

set of chosen colors for plotting.

Author(s)

Adrien Ickowicz <Adrien.Ickowicz@csiro.au>, Ross Sparks <Ross.Sparks@csiro.au>, Thomas Lo <Thomas.Lo@csiro.au>

Maintainer: Adrien Ickowicz <Adrien.Ickowicz@csiro.au>

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
cellIndices = rbind(c(2,9),c(2,10),c(3,9),c(3,10),
                    c(7,5),c(7,6),c(8,6),c(8,7))

dspSlices <- 1:13   # a vector containing time slices to be displayed

# allocate the first 24 months to find monthly means of each cell, and
# assuming 30 days for a month

test.fss <- FSS(AEGISS_ixyt, num1Slice=30, num1Period=12, 
            numPeriods=2, numX=10, numY=9, plotIte=8, 
            cellIndices=cellIndices, data_poly=AEGISS_poly,
            lambda=0.9, dspSlices=dspSlices, fillThreshold=0.95,
            colPoints="cyan")

ick003/RecurPart documentation built on May 18, 2019, 2:32 a.m.