summary.ergm_model: Evaluate network summary statistics from an initialized ergm...

View source: R/summary.ergm_model.R

summary.ergm_modelR Documentation

Evaluate network summary statistics from an initialized ergm model

Description

Returns a vector of the model's statistics for a given network or an empty network. This is a low-level function that should not be used by end-users, but may be useful to developers.

Usage

## S3 method for class 'ergm_model'
summary(object, nw = NULL, ...)

Arguments

object

an ergm_model object.

nw

a network whose statistics are to be evaluated, though an ergm_state object will also work. If NULL, returns empty network's statistics for that model.

...

Further arguments to methods.

response

Either a character string, a formula, or NULL (the default), to specify the response attributes and whether the ERGM is binary or valued. Interpreted as follows:

NULL

Model simple presence or absence, via a binary ERGM.

character string

The name of the edge attribute whose value is to be modeled. Type of ERGM will be determined by whether the attribute is logical (TRUE/FALSE) for binary or numeric for valued.

a formula

must be of the form NAME~EXPR|TYPE (with | being literal). EXPR is evaluated in the formula's environment with the network's edge attributes accessible as variables. The optional NAME specifies the name of the edge attribute into which the results should be stored, with the default being a concise version of EXPR. Normally, the type of ERGM is determined by whether the result of evaluating EXPR is logical or numeric, but the optional TYPE can be used to override by specifying a scalar of the type involved (e.g., TRUE for binary and 1 for valued).

See Also

summary_formula()


ergm documentation built on May 31, 2023, 8:04 p.m.