trendtestR (version 1.0.1)

explore_poisson_trend: Explore time-based GAM for count data trend with automatic model selection / Zeitbasierte GAM-Trendanalyse fuer Zaehldaten mit automatischer Modellauswahl

Description

Fits a Generalized Additive Model (GAM) with time-based splines to count data, supporting automatic selection between Poisson and Negative Binomial families. / Passt ein Generalisiertes Additives Modell (GAM) mit zeitbasierten Splines an Zaehldaten an, inklusive automatischer Auswahl zwischen Poisson und Negativer Binomialverteilung.

Usage

explore_poisson_trend(
  data,
  datum_col,
  value_col,
  group_col = NULL,
  k_spline = 4,
  family = c("auto", "poisson", "negbin"),
  phi = 1.5,
  return_formula = FALSE,
  verbose = FALSE
)

Value

A list containing: / Eine Liste mit:

model

Fitted GAM model object / Angepasstes GAM-Modellobjekt

summary

Summary of the model / Modellzusammenfassung

plot

ggplot of observed vs fitted trend / ggplot mit beobachteten und geschaetzten Trends

dispersion_parameter

List with overdispersion info (phi or theta) / Liste mit Overdispersion-Informationen (phi oder theta)

model_family_used

Model family used / Verwendete Modellfamilie

model_selection_info

Explanation of model selection / Beschreibung der Modellauswahl

effective_df

Effective degrees of freedom of smooth term(s) / Effektive Freiheitsgrade der glatten Terme

aic_comparison

AIC comparison if applicable / AIC-Vergleich, falls zutreffend

messages

Vector of fitting messages and warnings / Meldungen und Warnungen zur Modellanpassung

formula

Model formula used / Verwendete Modellformel

Arguments

data

Data frame with time series count data. / Data Frame mit Zeitreihen-Zaehldaten.

datum_col

Name of the time column (usually Date). / Name der Zeit-Spalte (normalerweise Date).

value_col

Name of the count column (dependent variable). / Name der Zaehldaten-Spalte (abhaengige Variable).

group_col

Optional. Name of grouping column for interaction. / Optional. Name der Gruppierungs-Spalte fuer Interaktion.

k_spline

Basis dimension for smooth terms (default = 4). Larger k allows more complex curves. / Basisdimension fuer glatte Terme (Standard = 4). Hoeheres k erlaubt komplexere Kurven.

family

Specifies the GAM family: "auto" (default, chooses based on overdispersion), "poisson", or "negbin". / Gibt die GAM-Familie an: "auto" (Standard, Auswahl basierend auf Overdispersion), "poisson" oder "negbin".

phi

Overdispersion parameter threshold for model selection (default = 1.5). / Schwellwert fuer Overdispersion zur Modellauswahl (Standard = 1.5).

return_formula

If TRUE, returns the model formula instead of fitting. / Wenn TRUE, wird die Modellformel zurueckgegeben.

verbose

Logical. Whether to print model fitting messages. / Ob Modellanpassungsmeldungen ausgegeben werden sollen.

See Also

[mgcv::gam()], [mgcv::nb()], [explore_zinb_trend()]

Examples

# Simulierte Zeitreihen-Zaehldaten
set.seed(123)
df <- data.frame(
  datum = seq.Date(from = as.Date("2023-01-01"), by = "day", length.out = 100),
  value = rpois(100, lambda = 5)
)

# Automatische Familienauswahl basierend auf Overdispersion
explore_poisson_trend(df, datum_col = "datum", value_col = "value", family = "auto")

# Negative Binomial-GAM erzwingen
explore_poisson_trend(df, datum_col = "datum", value_col = "value", family = "negbin")