ergmlhs: An API for specifying aspects of an 'ergm' model in the...

ergmlhsR Documentation

An API for specifying aspects of an ergm model in the LHS/basis network.

Description

%ergmlhs% extracts the setting, while assigning to it sets or updates it.

Usage

lhs %ergmlhs% setting

## S3 method for class 'network'
lhs %ergmlhs% setting

lhs %ergmlhs% setting <- value

## S3 method for class 'network'
lhs %ergmlhs% setting <- value

convert_ergmlhs(lhs)

## S3 method for class 'ergm_lhs'
print(x, ...)

## S3 method for class 'ergm_lhs'
summary(object, ...)

## S3 method for class 'summary.ergm_lhs'
print(x, ...)

Arguments

lhs

a network intended to serve as LHS of a ergm call.

setting

a character string holding a setting's name.

value

value with which to overwrite the setting.

Details

The settings are stored in a named list in an "ergm" network attribute attached to the LHS network. Currently understood settings include:

response

Edge attribute to be used as the response variable, constructed from the response= argument of ergm().

constraints

Structural constraints of the network: inherited by the constraints= argument of ergm(), simulate.formula(), etc..

obs.constraints

Structural constraints of the observation process: inherited by the obs.constraints= argument of ergm(), simulate.formula(), etc..

Functions

  • convert_ergmlhs: convert_ergmlhs converts old-style settings to new-style settings.

  • print.ergm_lhs: a print method.

  • summary.ergm_lhs: helper method for printing summary.

  • print.summary.ergm_lhs: helper method for printing summary.


ergm documentation built on June 2, 2022, 1:07 a.m.