Helper functions for adding, updating, removing, or getting a
vary_across
component in an Experiment
. When a
vary_across
component is added and the Experiment
is run, the
Experiment
is systematically varied across values of the specified
parameter in the DGP
or Method
while all other parameters are
held constant at their baseline value.
Usage
add_vary_across(.experiment, .dgp, .method, ...)
update_vary_across(.experiment, .dgp, .method, ...)
remove_vary_across(experiment, dgp, method, param_names = NULL)
get_vary_across(experiment)
Arguments
- .experiment, experiment
An
Experiment
object.- .dgp, dgp
Name of
DGP
to vary in theExperiment
. Can also be aDGP
object that matches one in theExperiment
.- .method, method
Name of
Method
to vary in theExperiment
. Can also be aMethod
object that matches one in theExperiment
.- ...
Any number of named arguments where names match an argument in the user-specified
DGP
orMethod
function and values are vectors (for scalar parameters) or lists (for arbitrary parameters).- param_names
A character vector of parameter names to remove. If not provided, the entire set of
vary_across
parameters will be removed for the specifiedDGP
/Method
.