control.simulate.stergm: Auxiliary for Controlling Separable Temporal ERGM Simulation

View source: R/control.simulate.stergm.R

control.simulate.networkR Documentation

Auxiliary for Controlling Separable Temporal ERGM Simulation

Description

Auxiliary function as user interface for fine-tuning STERGM simulation.

Usage

control.simulate.network(
  MCMC.burnin.min = 1000,
  MCMC.burnin.max = 1e+05,
  MCMC.burnin.pval = 0.5,
  MCMC.burnin.add = 1,
  MCMC.prop.form = ~discord + sparse,
  MCMC.prop.diss = ~discord + sparse,
  MCMC.prop.weights.form = "default",
  MCMC.prop.weights.diss = "default",
  MCMC.prop.args.form = NULL,
  MCMC.prop.args.diss = NULL,
  MCMC.maxedges = Inf,
  MCMC.maxchanges = 1e+06,
  term.options = NULL,
  MCMC.packagenames = c()
)

control.simulate.stergm(
  MCMC.burnin.min = NULL,
  MCMC.burnin.max = NULL,
  MCMC.burnin.pval = NULL,
  MCMC.burnin.add = NULL,
  MCMC.prop.form = NULL,
  MCMC.prop.diss = NULL,
  MCMC.prop.weights.form = NULL,
  MCMC.prop.weights.diss = NULL,
  MCMC.prop.args.form = NULL,
  MCMC.prop.args.diss = NULL,
  MCMC.maxedges = NULL,
  MCMC.maxchanges = NULL,
  term.options = NULL,
  MCMC.packagenames = NULL
)

Arguments

MCMC.burnin.min, MCMC.burnin.max, MCMC.burnin.pval, MCMC.burnin.add

Number of Metropolis-Hastings steps per time step used in simulation. By default, this is determined adaptively by keeping track of increments in the Hamming distance between the transitioned-from network and the network being sampled. Once MCMC.burnin.min steps have elapsed, the increments are tested against 0, and when their average number becomes statistically indistinguishable from 0 (with the p-value being greater than MCMC.burnin.pval), or MCMC.burnin.max steps are proposed, whichever comes first, the simulation is stopped after an additional MCMC.burnin.add times the number of elapsed steps have been taken. (Stopping immediately would bias the sampling.)

To use a fixed number of steps, set MCMC.burnin.min and MCMC.burnin.max to the same value.

MCMC.prop.form

Hints and/or constraints for selecting and initializing the proposal.

MCMC.prop.weights.form

Specifies the proposal weighting scheme to be used in the MCMC Metropolis-Hastings algorithm. Possible choices may be determined by calling ergm_proposal_table().

MCMC.prop.weights.diss, MCMC.prop.args.diss, MCMC.prop.diss

Ignored. These are included for backwards compatibility of calls to control functions only; they have no effect on simulate behavior.

MCMC.prop.args.form

An alternative, direct way of specifying additional arguments to proposals.

MCMC.maxedges

The maximum number of edges that may occur during the MCMC sampling. If this number is exceeded at any time, sampling is stopped immediately.

MCMC.maxchanges

Maximum number of changes for which to allocate space.

term.options

A list of additional arguments to be passed to term initializers. See ? term.options.

MCMC.packagenames

Names of packages in which to look for change statistic functions in addition to those autodetected. This argument should not be needed outside of very strange setups.

Details

This function is only used within a call to the simulate() function. See the Usage section in simulate.stergm() for details.

These functions are included for backwards compatibility, and users are encouraged to use control.simulate.tergm or control.simulate.formula.tergm with the simulate.tergm() family of functions instead. When a control.simulate.stergm or control.simulate.network object is passed to one of the simulate.stergm() functions, the corresponding simulate.tergm() function is invoked, and uses the formation proposal control arguments, ignoring the dissolution proposal control arguments.

Note: The old dissolution formula in stergm represents tie persistence. As a result it maps to the new Persist() operator in tergm, NOT the Diss() operator

Value

A list with arguments as components.

See Also

simulate.stergm(), simulate.formula(). control.stergm() performs a similar function for stergm().


tergm documentation built on Oct. 8, 2024, 5:09 p.m.