initRerandomizationExperimentalDesignObject {GreedyExperimentalDesign}R Documentation

This method creates an object of type rerandomization_experimental_design and will immediately initiate a search through $1_T$ space.

Description

This method creates an object of type rerandomization_experimental_design and will immediately initiate a search through $1_T$ space.

Usage

initRerandomizationExperimentalDesignObject(X, max_designs = 1000,
  obj_val_cutoff_to_include = NULL, objective = "mahal_dist",
  wait = FALSE, start = TRUE, num_cores = 1)

Arguments

X

The design matrix with $n$ rows (one for each subject) and $p$ columns (one for each measurement on the subject). This is the design matrix you wish to search for a more optimal design.

max_designs

The maximum number of designs to be returned. Default is 10,000. Make this large so you can search however long you wish as the search can be stopped at any time by using the stopSearch method

obj_val_cutoff_to_include

Only allocation vectors with objective values lower than this threshold will be returned. The default is NULL which means all vectors are returned.

objective

The objective function to use when searching the design space. This is a string "abs_sum_diff" (default) or "mahal_dist."

wait

Should the R terminal hang until all max_designs vectors are found? The default is FALSE.

start

Should we start searching immediately (default is TRUE).

num_cores

The number of CPU cores you wish to use during the search. The default is 1.

Value

An object of type rerandomization_experimental_design_search which can be further operated upon.

Author(s)

Adam Kapelner


[Package GreedyExperimentalDesign version 1.2 Index]