GeoLiftMultiCell: GeoLiftMultiCell inference calculation.

In facebookincubator/GeoLift: Synthetic Control Method to Calculate Lift at a Geo Level

GeoLiftMultiCell inference calculation.

Description

GeoLiftMultiCell performs inference for a Multi-Cell GeoLift.

Usage

GeoLiftMultiCell(
  Y_id = "Y",
  time_id = "time",
  location_id = "location",
  X = c(),
  data,
  locations,
  treatment_start_time,
  treatment_end_time,
  alpha = 0.1,
  model = "none",
  fixed_effects = TRUE,
  ConfidenceIntervals = TRUE,
  method = "conformal",
  grid_size = 250,
  stat_test = "Total",
  conformal_type = "iid",
  ns = 1000,
  winner_declaration = TRUE,
  geolift_type = "standard"
)

## S3 method for class 'GeoLiftMultiCell'
print(x, ...)

## S3 method for class 'GeoLiftMultiCell'
summary(object, table = FALSE, ...)

## S3 method for class 'GeoLiftMultiCell'
plot(
  x,
  type = "Lift",
  treatment_end_date = NULL,
  frequency = "daily",
  plot_start_date = NULL,
  title = "",
  post_treatment_periods = 0,
  stacked = TRUE,
  ...
)

Arguments

Y_id	Name of the outcome variable (String).
time_id	Name of the time variable (String).
location_id	Name of the location variable (String).
X	List of names of covariates.
data	A data.frame containing the historical conversions by geographic unit. It requires a "locations" column with the geo name, a "Y" column with the outcome data (units), a time column with the indicator of the time period (starting at 1), and covariates.
locations	A list of lists of test markets per cell. The recommended layout is list(cell_1 = list("locA"), cell2 = list("locB"), cell3 = list("locC"),...).
treatment_start_time	Time index of the start of the treatment.
treatment_end_time	Time index of the end of the treatment.
alpha	Significance level. Set to 0.1 by default.
model	A string indicating the outcome model used to augment the Augmented Synthetic Control Method. Augmentation through a prognostic function can improve fit and reduce L2 imbalance metrics. "None": ASCM is not augmented by a prognostic function. Defualt. "Ridge": Augments with a Ridge regression. Recommended to improve fit for smaller panels (less than 40 locations and 100 time-stamps.)) "GSYN": Augments with a Generalized Synthetic Control Method. Recommended to improve fit for larger panels (more than 40 locations and 100 time-stamps. "best: Fits the model with the lowest Scaled L2 Imbalance.
fixed_effects	A logic flag indicating whether to include unit fixed effects in the model. Set to TRUE by default.
ConfidenceIntervals	A logic flag indicating whether to estimate confidence intervals. Set to FALSE by default.
method	A string indicating the method used to calculate the aggregate ATT Confidence Intervals. "conformal": Conformal Inference. Defualt. "jackknife+": Jackknife+ (exclusively for stat_test = "Total").
grid_size	Number of grid points to use when inverting the hypothesis test for Conformal Inference. Set to 250 by default.
stat_test	A string indicating the test statistic. "Total": The test statistic is the sum of all treatment effects, i.e. sum(abs(x)). Default. "Negative": One-sided test against positive effects i.e. -sum(x). Recommended for Negative Lift tests. "Positive": One-sided test against negative effects i.e. sum(x). Recommended for Positive Lift tests.
conformal_type	Type of conformal inference used. Can be either "iid" for Independent and identically distributed or "block" for moving block permutations. Set to "iid" by default.
ns	Number of resamples for "iid" permutations if ⁠conformal_type = "iid⁠. Set to 1000 by default.
winner_declaration	Logic flag indicating whether to compute a winner cell analysis. If set to TRUE (default), both pairwise and total statistical significance tests will be performed.
geolift_type	String that specifies the type of GeoLift test to be performed: "standard": Standard GeoLift test where ads are shown to test regions. Defualt. "inverse": Inverse or Negative GeoLift test where the test group is holded-out from the treatment.
x	GeoLiftMultiCell()
...	additional arguments
object	GeoLiftMultiCell()
table	Logic flag indicating whether to plot only a table summarizing the results or the entire verbose output of each cell's GeoLift object summary. FALSE by default.
type	Type of plot. By default "Lift" which plots the incrementality on the outcome variable. If type is set to "ATT", the average ATT is plotted. If type is set to "Incrementality", daily incremental values are plotted.
treatment_end_date	Character that represents a date in year-month=day format.
frequency	Character that represents periodicity of time stamps. Can be either weekly or daily. Defaults to daily.
plot_start_date	Character that represents initial date of plot in year-month-day format.
title	String for the title of the plot. Empty by default.
post_treatment_periods	Number of post-treatment periods. Zero by default.
stacked	Logic flag indicating whether to stack all the Multi-Cell plots together vertically or to output each one of them separately. Set to TRUE by default.

Value

GeoLiftMultiCell object that contains:

• "results": List of GeoLift objects (one per cell).

• "pairwise": Table of pairwise comparisons and pairwise winner declarations.)

• "Winner": List of winner locations for the total comparison (if any).

facebookincubator/GeoLift documentation built on May 31, 2024, 10:09 a.m.