ergm_model | R Documentation |
ergm
network modelThese methods are generally not called directly by users, but may
be employed by other depending packages.
ergm_model
constructs it from a formula or a term list. Each term is
initialized via the InitErgmTerm
functions to create a
ergm_model
object.
ergm_model(
formula,
nw = NULL,
silent = FALSE,
...,
term.options = list(),
extra.aux = list(),
env = globalenv(),
offset.decorate = TRUE,
terms.only = FALSE
)
## S3 method for class 'ergm_model'
c(...)
as.ergm_model(x, ...)
## S3 method for class 'ergm_model'
as.ergm_model(x, ...)
## S3 method for class 'formula'
as.ergm_model(x, ...)
## S3 method for class 'ergm_model'
is.curved(object, ...)
## S3 method for class 'ergm_model'
is.dyad.independent(object, ...)
## S3 method for class 'ergm_model'
nparam(object, canonical = FALSE, offset = NA, byterm = FALSE, ...)
## S3 method for class 'ergm_model'
param_names(object, canonical = FALSE, offset = NA, ...)
formula |
An |
nw |
The network of interest, optionally instrumented with |
silent |
logical, whether to print the warning messages from the initialization of each model term. |
... |
additional parameters for model formulation |
term.options |
A list of additional arguments to be passed to term initializers. See |
extra.aux |
a list of auxiliary request formulas required elsewhere; if named, the resulting |
env |
a throwaway argument needed to prevent conflicts with some usages of |
offset.decorate |
logical; whether offset coefficient and parameter names should be enclosed in |
terms.only |
logical; whether auxiliaries, eta map, and UID constructions should be skipped. This is useful for submodels. |
x |
object to be converted to an |
object |
An |
canonical |
Whether the canonical (eta) parameters or the curved (theta) parameters are used. |
offset |
If |
byterm |
Whether to return a vector of the numbers of coefficients for each term. |
ergm_model
returns an ergm_model
object as a list
containing:
terms |
a list of terms and 'term components' initialized by the
appropriate |
etamap |
the theta -> eta mapping as a list returned from <ergm.etamap> |
uid |
a string generated with the model, \UIDalgo; different models are, generally, guaranteed to have different strings, but identical models are not guaranteed to have the same string |
c(ergm_model)
: A method for concatenating terms of two or more initialized models.
is.curved(ergm_model)
: Tests whether the model is curved.
is.dyad.independent(ergm_model)
: Tests whether the model is dyad-independent.
nparam(ergm_model)
: Number of parameters of the model.
param_names(ergm_model)
: Parameter names of the model.
This API is not to be considered fixed and may change between versions. However, an effort will be made to ensure that the methods of this class remain stable.
Earlier versions also had an optional response=
parameter that, if not NULL
, switched to valued mode and used the edge attribute named in response=
as the response. This is no longer used; instead, the response is to be set on nw
via ergm_preprocess_response(nw, response)
.
summary.ergm_model()
, ergm_preprocess_response()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.