R: Extract dyad-level ERGM constraint information into an...

as.rlebdm.ergm_conlist {ergm} | R Documentation

## Extract dyad-level ERGM constraint information into an `rlebdm` object

### Description

A function to combine the `free_dyads` attributes of the constraints appropriately to generate an `rlebdm` of dyads toggleable and/or missing and/or informative under that combination of constraints.

### Usage

    ## S3 method for class 'ergm_conlist'
    as.rlebdm(
      x,
      constraints.obs = NULL,
      which = c("free", "missing", "informative"),
      ...
    )

### Arguments

`x` | an `ergm_conlist` object: a list of initialised constraints. `NULL` is treated as a placeholder for no constraint (i.e., a constant matrix of `TRUE`).
`constraints.obs` | observation process constraints; defaults to `NULL` for all dyads observed (i.e., a constant matrix of `FALSE`).
`which` | which aspect of the constraint to extract: `free` for dyads that may be toggled under the constraints `x`; ignores `constraints.obs`; `missing` for dyads that are free but considered unobserved under the constraints; and `informative` for dyads that are both free and observed.
`...` | additional arguments, currently unused.

### Note

For `which=="free"` or `"informative"`, `NULL` return value is a placeholder for a matrix of `TRUE`, whereas for `which=="missing"` it is a placeholder for a matrix of `FALSE`.

Each element in the constraint list has a sign, which determins whether the constraint further restricts (for `+`) or potentially relaxes restriction (for `-`).

### See Also

ergm-constraints

[Package ergm version 4.1.2 Index]