Description Usage Arguments Value Methods (by generic) Note See Also
These methods are generally not called directly by users, but may
be employed by other depending packages.
ergm_model
constructs it from a formula. Each term is
initialized via the InitErgmTerm
functions to create a
ergm_model
object.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33  ergm_model(
formula,
nw = NULL,
silent = FALSE,
...,
term.options = list(),
extra.aux = list(),
env = globalenv(),
offset.decorate = TRUE
)
## 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; if passed, the LHS of 
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 
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:
coef.names 
a vector of coefficient names 
terms 
a list of terms and 'term components' initialized by the
appropriate 
etamap 
the theta > eta mapping as a list returned from <ergm.etamap> 
c
: A method for concatenating terms of two or more initialized models.
is.curved
: Tests whether the model is curved.
is.dyad.independent
: Tests whether the model is dyadindependent.
nparam
: Number of parameters of the model.
param_names
: 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.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.