Label-ergmTerm-6de33f4e: Modify terms' coefficient names

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

Modify terms' coefficient names

Description

This operator evaluates formula without modification, but modifies its coefficient and/or parameter names based on label and pos .

Usage

# binary: Label(formula, label, pos)

# valued: Label(formula, label, pos)

Arguments

formula	a one-sided ergm()-style formula with the terms to be evaluated
label	a character vector specifying the label for the terms, a list of two character vectors (see Details), or a function through which term names are mapped (or a as_mapper -style formula).
pos	controls how label modifies the term names: one of "prepend" , "replace" , "append" , or "(" , with the latter wrapping the term names in parentheses like a function call with name specified by label .

Details

If pos == "replace":

• Elements for which is.na(label) == TRUE are preserved.

• If the model is curved, ⁠label=⁠ can be a either function/mapper or a list with two elements, the first element giving the curved (model) parameter names and second giving the canonical parameter names. NULL leaves the respective name unchanged.

See Also

ergmTerm for index of model terms currently visible to the package.

\Sexpr[results=rd,stage=render]{ergm:::.formatTermKeywords("ergmTerm", "Label", "subsection")}

ergm documentation built on Oct. 7, 2024, 5:08 p.m.