apollo_makeCluster function

Creates cluster for estimation.

Splits data, creates cluster and loads different pieces of the database on each worker.

apollo_makeCluster(
  apollo_probabilities,
  apollo_inputs,
  silent = FALSE,
  cleanMemory = FALSE
)

Arguments

• apollo_probabilities: Function. Returns probabilities of the model to be estimated. Must receive three arguments:

  • ‘apollo_beta’ : Named numeric vector. Names and values of model parameters.
  • ‘apollo_inputs’ : List containing options of the model. See apollo_validateInputs .
  • ‘functionality’ : Character. Can be either ‘"components"’ , ‘"conditionals"’ , ‘"estimate"’ (default), ‘"gradient"’ , ‘"output"’ , ‘"prediction"’ , ‘"preprocess"’ , ‘"raw"’ , ‘"report"’ , ‘"shares_LL"’ , ‘"validate"’ or ‘"zero_LL"’ .

• apollo_inputs: List grouping most common inputs. Created by function apollo_validateInputs .

• silent: Boolean. If TRUE, no messages are printed to the terminal. FALSE by default. It overrides apollo_inputs$silent.

• cleanMemory: Boolean. If TRUE, it saves apollo_inputs to disc, and removes database and draws from the apollo_inputs in .GlobalEnv and the parent environment.

Returns

Cluster (i.e. an object of class cluster from package parallel)

Details

Internal use only. Called by apollo_estimate before estimation. Using multiple cores greatly increases memory consumption.