Skip to contents

Parse an ERGM Formula

Source: R/parse_ergm.R
parse_ergm_formula.Rd

Extracts ERGM term names and attributes from a formula. No fitted model is required. Returns a standardized data frame with metadata from the ERGM term database where available.

Usage

parse_ergm_formula(formula)

Arguments

formula

An ERGM formula.

Value

A data frame with columns:

term

Character. The canonical ERGM term name.

attribute

Character or NA. The attribute(s) used in the term, comma-separated when multiple.

estimate

Numeric. Always NA for formula-only parsing.

se

Numeric. Always NA for formula-only parsing.

pvalue

Numeric. Always NA for formula-only parsing.

description

Character or NA. Term description from the ERGM term database.

math

Character or NA. The mathematical definition (reserved for future use).

figure

Character or NA. Path to an associated figure (reserved for future use).

See also

parse_ergm_model for parsing fitted models, search.ergmTerms for the underlying term database.

Examples

if (FALSE) { # \dontrun{
library(ergm)
parse_ergm_formula(network ~ edges + nodematch("gender"))
} # }