ergm_model {ergm} | R Documentation |
Internal representation of an ergm
network model
Description
These 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.
Usage
ergm_model(object, nw = NULL, ..., formula = NULL)
## S3 method for class 'formula'
ergm_model(object, nw = NULL, ...)
## S3 method for class 'term_list'
ergm_model(
object,
nw = NULL,
silent = FALSE,
...,
term.options = list(),
env = globalenv(),
extra.aux = list(),
offset.decorate = TRUE,
terms.only = FALSE
)
## S3 method for class 'ergm_model'
ergm_model(
object,
nw,
...,
env = globalenv(),
extra.aux = list(),
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, byterm = FALSE, ..., ignore_aux = TRUE)
## 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, ...)
## S3 replacement method for class 'ergm_model'
param_names(object, canonical = FALSE, ...) <- value
Arguments
object |
An |
nw |
The network of interest, optionally instrumented with |
... |
additional parameters for model formulation |
formula |
An |
silent |
logical, whether to print the warning messages from the initialization of each model term. |
term.options |
A list of additional arguments to be passed to term initializers. See |
env |
a throwaway argument needed to prevent conflicts with some usages of |
extra.aux |
a list of auxiliary request formulas required elsewhere; if named, the resulting |
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 |
byterm |
Whether to return the result for each term individually. |
ignore_aux |
A flag to specify whether a dyad-dependent auxiliary should make the model dyad-dependent or should be ignored. |
canonical |
Whether the canonical (eta) parameters or the curved (theta) parameters are used. |
offset |
If |
value |
For |
Value
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> |
term.options |
the term options used to initialize the terms |
uid |
a string generated with the model, concatenating the UNIX time ( |
Methods (by class)
-
ergm_model(formula)
: a method forformula
: extracts thenetwork
and theterm_list
and passes it on to the next method. -
ergm_model(term_list)
: a method forterm_list
:nw=
is mandatory; initializes the terms in the list and passes it on to the next method. -
ergm_model(ergm_model)
: a method forterm_list
:nw=
is mandatory, andterm.options=
must be a part of theergm_model
object, with...
ignored; (re)generates the auxiliaries and, the eta map, and the unique ID; and decorates offsets.
Methods (by generic)
-
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. -
param_names(ergm_model) <- value
: Rename the parameters.
Note
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)
.
See Also
summary.ergm_model()
, ergm_preprocess_response()