prophet_decomp: Conduct prophet decomposition

View source: R/inputs.R

prophet_decompR Documentation

Conduct prophet decomposition

Description

When prophet_vars in robyn_inputs() is specified, this function decomposes trend, season, holiday and weekday from the dependent variable.

Usage

prophet_decomp(
  dt_transform,
  dt_holidays,
  prophet_country,
  prophet_vars,
  prophet_signs,
  factor_vars,
  context_vars,
  organic_vars,
  paid_media_spends,
  intervalType,
  dayInterval,
  custom_params
)

Arguments

dt_transform

A data.frame with all model features. Must contain ds column for time variable values and dep_var column for dependent variable values.

dt_holidays

data.frame. Raw input holiday data. Load standard Prophet holidays using data("dt_prophet_holidays")

context_vars, paid_media_spends, intervalType, dayInterval, prophet_country, prophet_vars, prophet_signs, factor_vars

As included in InputCollect

organic_vars

Character vector. Typically newsletter sendings, push-notifications, social media posts etc. Compared to paid_media_vars organic_vars are often marketing activities without clear spends.

custom_params

List. Custom parameters passed to prophet()

Value

A list containing all prophet decomposition output.


Robyn documentation built on June 27, 2024, 9:06 a.m.