R: Functions to initialize the MHproposal object

MHproposal {ergm}

R Documentation

Functions to initialize the MHproposal object

Description

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

Usage

                      
## S3 method for class 'character'
MHproposal(object, 
                   arguments, 
                   nw, ...,
                   response=NULL, 
                   reference=reference
                   )  
                      
                      
## S3 method for class 'formula'
MHproposal(object, 
                   arguments, 
                   nw, 
                   weights="default", 
                   class="c", 
                   reference=~Bernoulli, 
                   response=NULL,
                  ...)

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

Arguments

`object`	Either a character, a `formula` or an `ergm` object. The `formula` should be of the form `y ~ <model terms>`, where `y` is a network object or a matrix that can be coerced to a `network` object.
`nw`	The network object originally given to `ergm` via 'formula'
`weights`	Specifies the method used to allocate probabilities of being proposed to dyads; options are "TNT", "TNT10", "random", "nonobserved" and "default"; default="default"
`arguments`	A list of parameters used by the Init.MHP routines
`response`	EXPERIMENTAL. Name of the edge attribute whose value is to be modeled. Defaults to `NULL` for simple presence or absence.
`reference`	EXPERIMENTAL. One-sided formula whose RHS gives the reference measure to be used. (Defaults to `~Bernoulli`.)
`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 list of implemented constraints for more information.
`...`	Further arguments passed to other functions.

Value

Returns an MHproposal object: a list with class 'MHProposal' containing the following named elements:

name : the C name of the proposal
inputs : NULL (I think - the only non-null value returned by the InitMH is for <nobetweengroupties>, but this isn't included in the look-up table
package: shared library name where the proposal can be found (usually "ergm")
arguments: list of arguments passed to the InitMHP function; in particular,
- constraints: list of constraints
- constraints$bd: the list of parameters to bound degree in the fitting process and returned by ergm.bounddeg

Functions to initialize the MHproposal object

Description

Usage

Arguments

Value

See Also