tergm.godfather function

A function to apply a given series of changes to a network.

Gives the network a series of timed proposals it can't refuse. Returns the statistics of the network, and, optionally, the final network.

tergm.godfather(
  formula,
  changes = NULL,
  toggles = changes[, -4, drop = FALSE],
  start = NULL,
  end = NULL,
  end.network = FALSE,
  stats.start = FALSE,
  verbose = FALSE,
  control = control.tergm.godfather()
)

Arguments

• formula: An summary.formula()-style formula, with either a network or a networkDynamic

  as the LHS and statistics to be computed on the RHS. If LHS is a networkDynamic, it will be used to derive the changes to the network whose statistics are wanted. Otherwise, either changes or toggles must be specified, and the LHS network will be used as the starting network.

• changes: A matrix with four columns: time, tail, head, and new value, describing the changes to be made. Can only be used if LHS of formula is not a networkDynamic.

• toggles: A matrix with three columns: time, tail, and head, giving the dyads which had changed. Can only be used if LHS of formula is not a networkDynamic.

• start: Time from which to start applying changes. Note that the first set of changes will take effect at start + 1. Defaults to the time point 1 before the earliest change passed.

• end: Time at which to finish applying changes. Defaults to the last time point at which a change occurs.

• end.network: Whether to return the network that results. Defaults to FALSE.

• stats.start: Whether to return the network statistics at start (before any changes are applied) as the first row of the statistics matrix. Defaults to FALSE, to produce output similar to that of simulate()

  for TERGMs when output="stats", where initial network's statistics are not returned.

• verbose: A logical or an integer to control the amount of progress and diagnostic information to be printed. FALSE/0

  produces minimal output, with higher values producing more detail. Note that very high values (5+) may significantly slow down processing.

• control: A control list generated by control.tergm.godfather().

Returns

If end.network is FALSE (the default), an mcmc object with the requested network statistics associated with the network series produced by applying the specified changes. Its mcmc attributes encode the timing information: so start(out) gives the time point associated with the first row returned, and end(out) out the last. The "thinning interval" is always 1.

If end.network is TRUE, return a network object with lasttoggle "extension", representing the final network, with a matrix of statistics described in the previous paragraph attached to it as an attr-style attribute "stats".

See Also

simulate.tergm(), simulate_formula.network(), simulate_formula.networkDynamic()