Learn R Programming

ergm (version 4.8.1)

Fit, Simulate and Diagnose Exponential-Family Models for Networks

Description

An integrated set of tools to analyze and simulate networks based on exponential-family random graph models (ERGMs). 'ergm' is a part of the Statnet suite of packages for network analysis. See Hunter, Handcock, Butts, Goodreau, and Morris (2008) and Krivitsky, Hunter, Morris, and Klumb (2023) .

Copy Link

Version

Install

install.packages('ergm')

Monthly Downloads

6,955

Version

4.8.1

License

GPL-3 + file LICENSE

Maintainer

Pavel N. Krivitsky

Last Published

January 21st, 2025

Functions in ergm (4.8.1)

Curve-ergmTerm

Impose a curved structure on term parameters
DiscUnif2-ergmProposal

TODO
Dyads-ergmConstraint

Constrain fixed or varying dyad-independent terms
DiscUnifNonObserved-ergmProposal

TODO
DiscUnif-ergmProposal

TODO
DistRLE-ergmProposal

TODO
ConstantEdges-ergmProposal

MHp for edges constraints
CondOutDegree-ergmProposal

MHp for odegree constraints
DiscUnif-ergmReference

Discrete Uniform reference
Prod-ergmTerm

A product (or an arbitrary power combination) of one or more formulas
Unif-ergmReference

Continuous Uniform reference
F-ergmTerm

Filtering on arbitrary one-term model
NodematchFilter-ergmTerm

Filtering on nodematch
Log-ergmTerm

Take a natural logarithm of a network's statistic
HammingTNT-ergmProposal

TODO
Offset-ergmTerm

Terms with fixed coefficients
Exp-ergmTerm

Exponentiate a network's statistic
Symmetrize-ergmTerm

Evaluation on symmetrized (undirected) network
TNT-ergmProposal

Default MH algorithm
CondOutDegreeDist-ergmProposal

MHp for odegreedist constraints
Unif-ergmProposal

TODO
Label-ergmTerm

Modify terms' coefficient names
For-ergmTerm

A for operator for terms
b1factor-ergmTerm

Factor attribute effect for the first mode in a bipartite network
approx.hotelling.diff.test

Approximate Hotelling T^2-Test for One or Two Population Means
b1dsp-ergmTerm

Dyadwise shared partners for dyads in the first bipartition
anova.ergm

ANOVA for ERGM Fits
altkstar-ergmTerm

Alternating \(k\)-star
absdiffcat-ergmTerm

Categorical absolute difference in nodal attribute
b1cov-ergmTerm

Main effect of a covariate for the first mode in a bipartite network
Project-ergmTerm

Evaluation on a projection of a bipartite network
HammingConstantEdges-ergmProposal

TODO
StdNormal-ergmProposal

TODO
SPDyad-ergmProposal

A proposal alternating between TNT and a triad-focused proposal
b1concurrent-ergmTerm

Concurrent node count for the first mode in a bipartite network
b1degrange-ergmTerm

Degree range for the first mode in a bipartite network
b1factordistinct-ergmTerm

Number of distinct neighbor types for the first node
b1covrange-ergmTerm

Range of covariate values for neighbors of a mode-1 node
asymmetric-ergmTerm

Asymmetric dyads
atleast-ergmTerm

Number of dyads with values greater than or equal to a threshold
b2sociality-ergmTerm

Degree
S-ergmTerm

Evaluation on an induced subgraph
b1mindegree-ergmTerm

Minimum degree for the first mode in a bipartite network
StdNormal-ergmReference

Standard Normal reference
b2concurrent-ergmTerm

Concurrent node count for the second mode in a bipartite network
b2factor-ergmTerm

Factor attribute effect for the second mode in a bipartite network
b1twostar-ergmTerm

Two-star census for central nodes centered on the first mode of a bipartite network
Sum-ergmTerm

A sum (or an arbitrary linear combination) of one or more formulas
b2degrees-ergmConstraint

Preserve the receiver degree for bipartite networks
b2factordistinct-ergmTerm

Number of distinct neighbor types for the second mode
UnifNonObserved-ergmProposal

TODO
blocks-ergmConstraint

Constrain blocks of dyads defined by mixing type on a vertex attribute.
b2star-ergmTerm

\(k\)-stars for the second mode in a bipartite network
blockdiag-ergmConstraint

Block-diagonal structure constraint
b2dsp-ergmTerm

Dyadwise shared partners for dyads in the second bipartition
b1starmix-ergmTerm

Mixing matrix for \(k\)-stars centered on the first mode of a bipartite network
bd-ergmConstraint

Constrain maximum and minimum vertex degree
check.ErgmTerm

Ensures an Ergm Term and its Arguments Meet Appropriate Conditions
balance-ergmTerm

Balanced triads
b1star-ergmTerm

\(k\)-stars for the first mode in a bipartite network
call.ErgmTerm

Locate and call an ERGM term initialization function.
absdiff-ergmTerm

Absolute difference in nodal attribute
b1degree-ergmTerm

Degree for the first mode in a bipartite network
b1nodematch-ergmTerm

Nodal attribute-based homophily effect for the first mode in a bipartite network
b1degrees-ergmConstraint

Preserve the actor degree for bipartite networks
b2mindegree-ergmTerm

Minimum degree for the second mode in a bipartite network
as.network.numeric

Create a Simple Random network of a Given Size
b2nodematch-ergmTerm

Nodal attribute-based homophily effect for the second mode in a bipartite network
b1sociality-ergmTerm

Degree
atmost-ergmTerm

Number of dyads with values less than or equal to a threshold
as.rlebdm.ergm_conlist

Extract dyad-level ERGM constraint information into an rlebdm object
b2degrange-ergmTerm

Degree range for the second mode in a bipartite network
b2cov-ergmTerm

Main effect of a covariate for the second mode in a bipartite network
attrcov-ergmTerm

Edge covariate by attribute pairing
b2covrange-ergmTerm

Range of covariate values for neighbors of a mode-2 node
b2degree-ergmTerm

Degree for the second mode in a bipartite network
control.ergm

Auxiliary function for fine-tuning ERGM fitting.
cohab

Target statistics and model fit to a hypothetical 50,000-node network population with 50,000 nodes based on egocent
concurrent-ergmTerm

Concurrent node count
ctriple-ergmTerm

Cyclic triples
coincidence-ergmTerm

Coincident node count for the second mode in a bipartite (aka two-mode) network
control.simulate.ergm

Auxiliary for Controlling ERGM Simulation
cycle-ergmTerm

k-Cycle Census
concurrentties-ergmTerm

Concurrent tie count
cyclicalties-ergmTerm

Cyclical ties
control.ergm.bridge

Auxiliaries for Controlling ergm.bridge.llr() and logLik.ergm()
degcrossprod-ergmTerm

Degree Cross-Product
control.gof

Auxiliary for Controlling ERGM Goodness-of-Fit Evaluation
control.san

Auxiliary for Controlling SAN
degree-ergmTerm

Degree
degcor-ergmTerm

Degree Correlation
cyclicalweights-ergmTerm

Cyclical weights
dyadcov-ergmTerm

Dyadic covariate
degrange-ergmTerm

Degree range
edgecov-ergmTerm

Edge covariate
b2starmix-ergmTerm

Mixing matrix for \(k\)-stars centered on the second mode of a bipartite network
b2twostar-ergmTerm

Two-star census for central nodes centered on the second mode of a bipartite network
degrees-ergmConstraint

Preserve the degree of each vertex of the given network
dyadnoise-ergmConstraint

A soft constraint to adjust the sampled distribution for dyad-level noise with known perturbation probabilities
density-ergmTerm

Density
edges-ergmConstraint

Preserve the edge count of the given network
degreedist-ergmConstraint

Preserve the degree distribution of the given network
dsp-ergmTerm

Directed dyadwise shared partners
degreedist

Computes and Returns the Degree Distribution Information for a Given Network
.dyads-ergmConstraint

A meta-constraint indicating handling of arbitrary dyadic constraints
diff-ergmTerm

Difference
egocentric-ergmConstraint

Preserve values of dyads incident on vertices with given attribute
edges-ergmTerm

Number of edges in the network
degree1.5-ergmTerm

Degree to the 3/2 power
ergm-defunct

Functions that have been removed from this package
ergm-options

Global options and term options for the ergm package
ergm-deprecated

Functions that will no longer be supported in future releases of the package
ergm-package

ergm: Fit, Simulate and Diagnose Exponential-Family Models for Networks
dyadnoise-ergmProposal

TODO
ergm-errors

Sensible error and warning messages by ergm initializers
dyadnoiseTNT-ergmProposal

TODO
ergm-internal

Internal ergm Objects
equalto-ergmTerm

Number of dyads with values equal to a specific value (within tolerance)
ecoli

Two versions of an E. Coli network dataset
enformulate.curved-deprecated

Convert a curved ERGM into a form suitable as initial values for the same ergm. Deprecated in 4.0.0.
ergm.geodistdist

Calculate geodesic distance distribution for a network or edgelist
ergm.getnetwork

Acquire and verify the network from the LHS of an ergm formula and verify that it is a valid network.
ergm-parallel

Parallel Processing in the ergm Package
ergm.design

Obtain the set of informative dyads based on the network structure.
ergm.eta

Operations to map curved ergm() parameters onto canonical parameters
ergm.estfun

Compute the Sample Estimating Function Values of an ERGM.
ergm

Exponential-Family Random Graph Models
ergm.godfather

A function to apply a given series of changes to a network.
ergm.allstats

Calculate all possible vectors of statistics on a network for an ERGM
ergm.bridge.llr

Bridge sampling to evaluate ERGM log-likelihoods and log-likelihood ratios
ergmMPLE

ERGM Predictors and response for logistic regression calculation of MPLE
ergmProposal

Metropolis-Hastings Proposal Methods for ERGM MCMC
ergmConstraint

Sample Space Constraints for Exponential-Family Random Graph Models
ergm.mple

Find a maximizer to the psuedolikelihood function
ergm_Cstate_clear

ergmHint

MCMC Hints for Exponential-Family Random Graph Models
ergmReference

Reference Measures for Exponential-Family Random Graph Models
ergmTerm

Terms used in Exponential Family Random Graph Models
ergm_GWDECAY

Curved settings for geometric weights for the gw* terms
ergmKeyword

Keywords defined for Exponential-Family Random Graph Models
ergm_plot.mcmc.list

Plot MCMC list using lattice package graphics
ergm_MCMC_sample

Internal Function to Sample Networks and Network Statistics
ergm_model

Internal representation of an ergm network model
ergm_mk_std_op_namewrap

Combine an operator term's and a subterm's name in a standard fashion.
ergm_bd_init

Initializes the parameters to bound degree during sampling
ergm_SAN_slave

Internal Function to Perform Simulated Annealing
ergm_dyadgen_select

A helper function to select and construct a dyad generator for C.
ergm_edgecov_args

A common pattern for obtaining an edge covariate
ergm_cutoff_message

Helper function for constructing gw* cutoff error messages
ergm_state_cache

A rudimentary cache for large objects
esp-ergmTerm

Directed edgewise shared partners
ergm_symmetrize

Return a symmetrized version of a binary network
ergm_keyword

Dynamic ERGM keyword registry
ergm_proposal_table

Table mapping reference,constraints, etc. to ERGM Metropolis-Hastings proposals
ergmlhs

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

Update the network and the response argument.
ergm_state

A Representation of ERGM state
ergm_proposal

Functions to initialize the ergm_proposal object
faux.mesa.high

Goodreau's Faux Mesa High School as a network object
faux.desert.high

Faux desert High School as a network object
ergm_propagate_ext.encode

Extended states for submodels
fix.curved

Convert a curved ERGM into a corresponding "fixed" ERGM.
faux.magnolia.high

Goodreau's Faux Magnolia High School as a network object
faux.dixon.high

Faux dixon High School as a network object
fixedas-ergmConstraint

Fix specific dyads
fixallbut-ergmConstraint

Preserve the dyad status in all but the given edges
g4

Goodreau's four node network as a "network" object
florentine

Florentine Family Marriage and Business Ties Data as a "network" object
greaterthan-ergmTerm

Number of dyads with values strictly greater than a threshold
gof

Conduct Goodness-of-Fit Diagnostics on a Exponential Family Random Graph Model
gwesp-ergmTerm

Geometrically weighted edgewise shared partner distribution
gwidegree-ergmTerm

Geometrically weighted in-degree distribution
gwdegree-ergmTerm

Geometrically weighted degree distribution
gwdsp-ergmTerm

Geometrically weighted dyadwise shared partner distribution
idegrange-ergmTerm

In-degree range
gwb2dsp-ergmTerm

Geometrically weighted dyadwise shared partner distribution for dyads in the second bipartition
gwb2degree-ergmTerm

Geometrically weighted degree distribution for the second mode in a bipartite network
gwb1degree-ergmTerm

Geometrically weighted degree distribution for the first mode in a bipartite network
gwb1dsp-ergmTerm

Geometrically weighted dyadwise shared partner distribution for dyads in the first bipartition
idegree1.5-ergmTerm

In-degree to the 3/2 power
hamming-ergmConstraint

Preserve the hamming distance to the given network (BROKEN: Do NOT Use)
isolatededges-ergmTerm

Isolated edges
hamming-ergmTerm

Hamming distance
idegreedist-ergmConstraint

Preserve the indegree distribution
idegrees-ergmConstraint

Preserve indegree for directed networks
kstar-ergmTerm

\(k\)-stars
localtriangle-ergmTerm

Triangles within neighborhoods
geweke.diag.mv

Multivariate version of coda's coda::geweke.diag().
get.node.attr

Retrieve and check assumptions about vertex attributes (nodal covariates) in a network
nearsimmelian-ergmTerm

Near simmelian triads
ininterval-ergmTerm

Number of dyads whose values are in an interval
network.list

A convenience container for a list of network objects, output by simulate.ergm() among others.
gwnsp-ergmTerm

Geometrically weighted non-edgewise shared partner distribution
gwodegree-ergmTerm

Geometrically weighted out-degree distribution
is.dyad.independent

Testing for dyad-independence
isolates-ergmTerm

Isolates
logLik.ergm

A logLik() method for ergm fits.
logLikNull

Calculate the null model likelihood
is.valued

Function to check whether an ERGM fit or some aspect of it is valued
idegree-ergmTerm

In-degree
istar-ergmTerm

In-stars
mutual-ergmTerm

Mutuality
molecule

Synthetic network with 20 nodes and 28 edges
kapferer

Kapferer's tailor shop data
nodeicovar-ergmTerm

Covariance of in-dyad values incident on each actor
nodeicovrange-ergmTerm

Range of covariate values for in-neighbors of a node
nodal_attributes-API

Helper functions for specifying nodal attribute levels
meandeg-ergmTerm

Mean vertex degree
m2star-ergmTerm

Mixed 2-stars, a.k.a 2-paths
is.curved

Testing for curved exponential family
nodecovrange-ergmTerm

Range of covariate values for neighbors of a node
nodefactor-ergmTerm

Factor attribute effect
intransitive-ergmTerm

Intransitive triads
nodeifactor-ergmTerm

Factor attribute effect for in-edges
nodefactordistinct-ergmTerm

Number of distinct neighbor types
mcmc.diagnostics

Conduct MCMC diagnostics on a model fit
mm-ergmTerm

Mixing matrix cells and margins
nodecov-ergmTerm

Main effect of a covariate
nodeicov-ergmTerm

Main effect of a covariate for in-edges
nodeifactordistinct-ergmTerm

Number of distinct in-neighbor types
opentriad-ergmTerm

Open triads
ostar-ergmTerm

k-Outstars
nodal_attributes

Specifying nodal attributes and their levels
nodeocovrange-ergmTerm

Range of covariate values for out-neighbors of a node
nodeofactor-ergmTerm

Factor attribute effect for out-edges
odegreedist-ergmConstraint

Preserve the outdegree distribution
nodemix-ergmTerm

Nodal attribute mixing
nodematch-ergmTerm

Uniform homophily and differential homophily
nodeofactordistinct-ergmTerm

Number of distinct out-neighbor types
odegree-ergmTerm

Out-degree
nodecovar-ergmTerm

Covariance of undirected dyad values incident on each actor
receiver-ergmTerm

Receiver effect
rlebdm

RLE-Compressed Boolean Dyad Matrix
odegrange-ergmTerm

Out-degree range
observed-ergmConstraint

Preserve the observed dyads of the given network
predict.formula

ERGM-based tie probabilities
nodeocov-ergmTerm

Main effect of a covariate for out-edges
odegree1.5-ergmTerm

Out-degree to the 3/2 power
param_names

Names of the parameters associated with an object.
san

Generate networks with a given set of network statistics
search.ergmTerms

Search ERGM terms, constraints, references, hints, and proposals
nodeocovar-ergmTerm

Covariance of out-dyad values incident on each actor
nsp-ergmTerm

Directed non-edgewise shared partners
randomtoggle-ergmProposal

Propose a randomly selected dyad to toggle
rank_test.ergm

A lack-of-fit test for ERGMs
nparam

Length of the parameter vector associated with an object or with its terms.
nvattr.copy.network

Copy network- and vertex-level attributes between two network objects
smalldiff-ergmTerm

Number of ties between actors with similar attribute values
sender-ergmTerm

Sender effect
shrink_into_CH

Identify the position of a point relative to the convex hull of a set of points
smallerthan-ergmTerm

Number of dyads with values strictly smaller than a threshold
simmelian-ergmTerm

Simmelian triads
odegrees-ergmConstraint

Preserve outdegree for directed networks
simmelianties-ergmTerm

Ties in simmelian triads
threetrail-ergmTerm

Three-trails
to_ergm_Cdouble.network

Methods to serialize objects into numeric vectors for passing to the C side.
strat-ergmHint

Stratify Proposed Toggles by Mixing Type on a Vertex Attribute
sum-ergmTerm

Sum of dyad values (optionally taken to a power)
sociality-ergmTerm

Undirected degree
summary.ergm

Summarizing ERGM Model Fits
snctrl

Statnet Control
triadic-ergmHint

Network with strong clustering (triad-closure) effects
summary.ergm_model

Evaluate network summary statistics from an initialized ergm model
transitiveties-ergmTerm

Transitive ties
transitive-ergmTerm

Transitive triads
tripercent-ergmTerm

Triangle percentage
ttriple-ergmTerm

Transitive triples
triangle-ergmTerm

Triangles
transitiveweights-ergmTerm

Transitive weights
wtd.median

Weighted Median
triadcensus-ergmTerm

Triad census
sparse-ergmHint

Sparse network
spectrum0.mvar

Multivariate version of coda's spectrum0.ar().
wrap.ergm_model

Wrap a submodel's curved, empty network statistics, and extended state (read-only) specification (if present) for output from an InitErgmTerm or InitWtErgmTerm.
simulate.formula

A simulate Method for formula objects that dispatches based on the Left-Hand Side
samplk

Longitudinal networks of positive affection within a monastery as a "network" object
simulate.ergm

Draw from the distribution of an Exponential Family Random Graph Model
twopath-ergmTerm

2-Paths
update.network

Update the edges in a network based on a matrix
sampson

Cumulative network of positive affection within a monastery as a "network" object
summary_formula

Dispatching a summary function based on the class of the LHS of a formula.
summary.formula

Calculation of network or graph statistics or other attributes specified on a formula
CondB2Degree-ergmProposal

MHp for b2degree constraints
Bernoulli-ergmReference

Bernoulli reference
B-ergmTerm

Wrap binary terms for use in valued models
CondInDegree-ergmProposal

MHp for idegree constraints
CondB1Degree-ergmProposal

MHp for b1degree constraints
CondDegreeDist-ergmProposal

MHp for degreedist constraints
CondDegree-ergmProposal

MHp for degree constraints
BDStratTNT-ergmProposal

TNT proposal with degree bounds, stratification, and a blocks constraint
CondDegreeMix-ergmProposal

MHp for degree mix constraints
CondInDegreeDist-ergmProposal

MHp for idegreedist constraints