ergm_proposal_table {ergm}

Table mapping reference,constraints, etc. to ERGM Metropolis-Hastings proposals

Description

This is a low-level function not intended to be called directly by end users. For information on Metropolis-Hastings proposal methods, ergm-proposals. This function sets up the table mapping constraints, references, etc. to ergm_proposals. Calling it with arguments adds a new row to this table. Calling it without arguments returns the table so far.

Usage

ergm_proposal_table(
  Class,
  Reference,
  Constraints,
  Priority,
  Weights,
  Proposal,
  Package = NULL
)

Arguments

Class

default to "c"

Reference

The reference measure used in the model. For the list of reference measures, see ergmReference

Constraints

The constraints used in the model. For the list of constraints, see ergmConstraint. They are specified as a single string of text, with each contrast prefixed by either & for constraints that the proposal always enforces or | for constraints that the proposal can enforce if needed.

Priority

On existence of multiple qualifying proposals, specifies the priority (-1,0,1, etc.) of proposals to be used.

Weights

The sampling weights on selecting toggles (random, TNT, etc).

Proposal

The matching proposal from the previous arguments.

Package

The package in which the proposal is implemented; it's normally autodetected based on the package to which the calling function belongs.

Details

The first time a particular package calls ergm_proposal_table(), it also sets a call-back to remove all of its proposals from the table should the package be unloaded.

Note

The arguments Class, Reference, and Constraints can have length greater than 1. If this is the case, the rows added to the table are a Cartesian product of their elements.