ergm_proposal {ergm} | R Documentation |
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 ergmProposal
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 |
... |
Further arguments passed to other functions. |
arguments |
A list of parameters used by the InitErgmProposal routines |
nw |
The network object originally given to |
reference |
A one-sided formula specifying
the reference measure ( |
term.options |
A list of additional arguments to be passed to term initializers. See |
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 |
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 |
reference |
the reference distribution |
arguments |
list of arguments passed to
the
|
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 theergm_conlist
object and hands off toergm_proposal.ergm_conlist()
. -
ergm_proposal(term_list)
:object
argument is aterm_list
; same implementation as theformula
method. -
ergm_proposal(ergm_conlist)
:object
argument is an ERGM constraint list; constructs the internalergm_reference
object, looks up the proposal, and hands off toergm_proposal.character()
. -
ergm_proposal(ergm)
:object
argument is anergm
fit whose proposals are extracted which is reproduced as best as possible.