ergmAuxiliary: Auxiliaries to Facilitate Terms in Exponential Family Random...

In statnet/ergm: Fit, Simulate and Diagnose Exponential-Family Models for Networks

Auxiliaries to Facilitate Terms in Exponential Family Random Graph Models

Description

This page is intended for term developers and provides information about auxiliaries—terms that do not produce statistics of their own but provide useful data structures for other terms to use. It also provides an indexed list of the possible auxiliaries currently visible to the ergm API. Terms can also be searched via search.ergmAuxiliaries, and help for an individual auxiliaries can be obtained with ⁠ergmAuxiliary?<term>⁠ or help("<term>-ergmAuxiliary").

By convention, their names are prefixed with a dot.

Usage

search.ergmAuxiliaries(search, keywords, name, packages)

Arguments

search	optional character search term to search for in the text of the term descriptions. Only matching terms will be returned. Matching is case insensitive.
keywords	optional character vector of keyword tags to use to restrict the results (i.e. 'curved', 'triad-related')
name	optional character name of a specific term to return
packages	optional character vector indicating the subset of packages in which to search

Auxiliary index

\ergmCSS \Sexpr[results=rd,stage=render]{ergm:::.formatIndexHtml(ergm:::.buildTermsDataframe("ergmAuxiliary"))}

All terms

\Sexpr[results=rd,stage=render]{ergm:::.formatMatrixHtml(ergm:::.termMatrix("ergmAuxiliary"))}

Terms by keywords

\Sexpr[results=rd,stage=render]{ergm:::.formatTocHtml(ergm:::.termToc("ergmAuxiliary"))}

See Also

ergm package, ergm, network, %v%, %n%

Examples

# find all of the auxiliaries
search.ergmAuxiliaries()

statnet/ergm documentation built on Feb. 28, 2025, 7:05 p.m.