run_synthetic_forecast: run_synthetic_forecast

In SynthCast: Synthetic Control Method to Forecast Series

run_synthetic_forecast

Description

Executes all the other package functions in order to have a list with the results table.

Usage

run_synthetic_forecast(
  df,
  col_unit_name,
  unit_of_interest,
  col_time,
  periods_to_forecast,
  serie_of_interest
)

Arguments

df	Main DataFrame.
col_unit_name	String with column name of the column with the units names.
unit_of_interest	Value of the col_unit_name that is of interest.
col_time	String with the column name of the time column.
periods_to_forecast	(Integer) Number of periods to forecast.
serie_of_interest	Column name os the serie to be projected.

Value

List with results table.

Examples

synthetic_forecast <- run_synthetic_forecast(
df = df_example,
col_unit_name = 'unit',
col_time='time_period',
periods_to_forecast=12,
unit_of_interest = '30',
serie_of_interest = 'x1'
)

SynthCast documentation built on March 18, 2022, 5:48 p.m.