ergm_proposal: Functions to initialize the ergm_proposal object

In ergm: Fit, Simulate and Diagnose Exponential-Family Models for Networks

Functions to initialize the ergm_proposal object

Description

S3 Functions that initialize the Metropolis-Hastings Proposal (ergm_proposal) object using the ⁠InitErgmProposal.*⁠ function that corresponds to the name given in 'object'. These functions are not generally called directly by the user. See ergm-proposals for general explanation and lists of available Metropolis-Hastings proposal types.

Usage

ergm_proposal(object, ...)

## S3 method for class 'character'
ergm_proposal(
  object,
  arguments,
  nw,
  ...,
  reference = ergm_reference(trim_env(~Bernoulli), nw, term.options = term.options, ...),
  term.options = list()
)

## S3 method for class 'formula'
ergm_proposal(
  object,
  arguments,
  nw,
  hints = trim_env(~sparse),
  ...,
  term.options = list()
)

## S3 method for class 'term_list'
ergm_proposal(
  object,
  arguments,
  nw,
  hints = trim_env(~sparse),
  ...,
  term.options = list()
)

## S3 method for class 'ergm_conlist'
ergm_proposal(
  object,
  arguments,
  nw,
  weights = "default",
  class = "c",
  reference = trim_env(~Bernoulli),
  ...,
  term.options = list()
)

## S3 method for class 'ergm'
ergm_proposal(
  object,
  ...,
  constraints = NULL,
  arguments = NULL,
  nw = NULL,
  weights = NULL,
  class = "c",
  reference = NULL
)

Arguments

object	Either a character, a formula or an ergm object. The formula should be of the format documented in the constraints argument of ergm() and in the ERGM constraints documentation.
...	Further arguments passed to other functions.
arguments	A list of parameters used by the InitErgmProposal routines
nw	The network object originally given to ergm via 'formula'
reference	A one-sided formula specifying the reference measure (h(y)) to be used. See help for ERGM reference measures implemented in the ergm package.
term.options	A list of additional arguments to be passed to term initializers. See ? term.options.
weights	Specifies the method used to allocate probabilities of being proposed to dyads, providing an intermediate method (between hints and specifying the proposal name directly) for specifying the proposal; options include "TNT", "StratTNT", "TNT10", "random", "nonobserved" and "default"; default="default"
class	The class of the proposal; choices include "c", "f", and "d" default="c".
constraints	A one-sided formula specifying one or more constraints on the support of the distribution of the networks being simulated. See the documentation for a similar argument for ergm and see ergmConstraint for more information.

Value

Returns an ergm_proposal object: a list with class ergm_proposal containing the following named elements:

name	the C name of the proposal
inputs	inputs to be passed to C
pkgname	shared library name where the proposal can be found (usually "ergm")
reference	the reference distribution
arguments	list of arguments passed to the InitErgmProposal function; in particular, constraints list of constraints uid a string generated with the proposal, \UIDalgo; different proposals are, generally, guaranteed to have different strings, but identical proposals are not guaranteed to have the same string

Methods (by class)

• ergm_proposal(character): object argument is a character string giving the R name of the proposal.

• ergm_proposal(formula): object argument is an ERGM constraint formula; constructs the ergm_conlist object and hands off to ergm_proposal.ergm_conlist().

• ergm_proposal(term_list): object argument is a term_list; same implementation as the formula method.

• ergm_proposal(ergm_conlist): object argument is an ERGM constraint list; constructs the internal ergm_reference object, looks up the proposal, and hands off to ergm_proposal.character().

• ergm_proposal(ergm): object argument is an ergm fit whose proposals are extracted which is reproduced as best as possible.

See Also

InitErgmProposal

ergm documentation built on May 31, 2023, 8:04 p.m.