robyn_run  R Documentation 
robyn_run()
consumes robyn_input()
outputs,
runs robyn_mmm()
, and collects all modeling results.
robyn_run(
InputCollect = NULL,
dt_hyper_fixed = NULL,
json_file = NULL,
ts_validation = FALSE,
add_penalty_factor = FALSE,
refresh = FALSE,
seed = 123L,
quiet = FALSE,
cores = NULL,
trials = 5,
iterations = 2000,
rssd_zero_penalty = TRUE,
objective_weights = NULL,
nevergrad_algo = "TwoPointsDE",
intercept = TRUE,
intercept_sign = "non_negative",
lambda_control = NULL,
outputs = FALSE,
...
)
## S3 method for class 'robyn_models'
print(x, ...)
InputCollect 
List. Contains all input parameters for the model.
Required when 
dt_hyper_fixed 
data.frame or named list. Only provide when loading
old model results. It consumes hyperparameters from saved csv

json_file 
Character. JSON file to import previously exported inputs or
recreate a model. To generate this file, use 
ts_validation 
Boolean. When set to 
add_penalty_factor 
Boolean. Add penalty factor hyperparameters to glmnet's penalty.factor to be optimized by nevergrad. Use with caution, because this feature might add too much hyperparameter space and probably requires more iterations to converge. 
refresh 
Boolean. Set to 
seed 
Integer. For reproducible results when running nevergrad. 
quiet 
Boolean. Keep messages off? 
cores 
Integer. Default to 
trials 
Integer. Recommended 5 for default

iterations 
Integer. Recommended 2000 for default when using

rssd_zero_penalty 
Boolean. When TRUE, the objective function DECOMP.RSSD will penalize models with more 0 media effects additionally. In other words, given the same DECOMP.RSSD score, a model with 50% 0coef variables will get penalized by DECOMP.RSSD * 1.5 (larger error), while another model with no 0coef variables gets unpenalized with DECOMP.RSSD * 1. 
objective_weights 
Numeric vector. Default to NULL to give equal weights
to all objective functions. Order: NRMSE, DECOMP.RSSD, MAPE (when calibration
data is provided). When you are not calibrating, only the first 2 values for

nevergrad_algo 
Character. Default to "TwoPointsDE". Options are

intercept 
Boolean. Should intercept(s) be fitted (default=TRUE) or set to zero (FALSE). 
intercept_sign 
Character. Choose one of "non_negative" (default) or
"unconstrained". By default, if intercept is negative, Robyn will drop intercept
and refit the model. Consider changing intercept_sign to "unconstrained" when
there are 
lambda_control 
Deprecated in v3.6.0. 
outputs 
Boolean. If set to TRUE, will run 
... 
Additional parameters passed to 
x 

List. Class: robyn_models
. Contains the results of all trials
and iterations modeled.
List. Contains all trained models. Class: robyn_models
.
## Not run:
# Having InputCollect results
OutputModels < robyn_run(
InputCollect = InputCollect,
cores = 2,
iterations = 200,
trials = 1
)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.