SimulateROASAnalysis: [internal] Performs a ROAS analysis on one simulated data set...

In google/GeoexperimentsResearch: Geo Experiments

Description

[internal] Performs a ROAS analysis on one simulated data set drawn from the GeoExperimentPreanalysisData object.

Usage

.SimulateROASAnalysis(sim, randomize.i, obj, response, prop.to, cost = 1,
  models = GetModelIds(), swap.and.redo = FALSE)

Arguments

sim	(integer >= 1) number of the simulation; if 'randomize.i' is FALSE, 'sim' will be used as the number of the data set to draw.
randomize.i	(flag) if TRUE, the number of the data set will be drawn at random. If FALSE, the number of the data set will be set equal to sim.
obj	a GeoExperimentPreanalysisData object.
response	(string) name of the metric column to use as the response variable.
prop.to	(string) an existing name of the column in proportion to which the spend change will be distributed across the geos.
cost	(real number) incremental cost, assumed fixed and known.
models	(vector of nonempty strings) one or more analysis model ids. The simulated data set is apply to simulated data set. By default, all possible models are fit.
swap.and.redo	(flag) swap groups and redo the analysis? Note: number of groups must be 2 if this flag is TRUE. Since this produces two simulations, the indices of simulations that are registered will be 2 * sim - 1 and 2 * sim.

Value

A ROASAnalysisFit object, a data frame with one or more rows.

Note

This is an internal function, called from another function. No integrity checking of the parameters is done; this must be done by the enclosing function.

google/GeoexperimentsResearch documentation built on May 17, 2019, 7:42 a.m.