gtp {stppSim}

Global temporal pattern (GTP)

Description

Models the global temporal pattern, as combining the long-term trend and seasonality.

Usage

gtp(start_date, trend = "stable",
slope = NULL, shortTerm = "cyclical",
fPeak = 90, show.plot =FALSE)

Arguments

start_date

the start date of the temporal pattern. The date should be in the format "yyyy-mm-dd". The GTP will normally cover a 1-year period.

trend

specifies the direction of the long-term trend. Options are: "falling", "stable", and "rising". Default value is: "stable".

slope

slope of the long-term trend when an "rising" or "falling" trend is specified. Options: "gentle" or "steep". The default value is set as NULL for the stable trend.

shortTerm

type of short- to medium-term fluctuations (patterns) of the time series. Options are: `"cyclical"` and `"acyclical"`. Default is: `"cyclical"`.

fPeak

first seasonal peak of cyclical short term. Default value is 90. Set as NULL for "acyclical" short term pattern.

show.plot

(logical) Shows 'gtp'. Default is FALSE.

Details

Models the GTP for anchoring the temporal trends and patterns of the point patterns to be simulated.

Value

Returns a time series (list) of 365 data points representing 1-year global temporal pattern.

Examples

gtp(start_date = "2020-01-01", trend = "stable",
slope = NULL, shortTerm = "cyclical",
fPeak = 90, show.plot = FALSE)