coDyadCovar: Function to create a constant dyadic covariate object.

View source: R/sienautils.r

coDyadCovarR Documentation

Function to create a constant dyadic covariate object.

Description

This function creates a constant dyadic covariate object from a matrix.

Usage

coDyadCovar(val, centered=TRUE, nodeSets=c("Actors", "Actors"),
     warn=TRUE, sparse=inherits(val,"TsparseMatrix"), type=c("oneMode", "bipartite"))

Arguments

val

Matrix of covariate values. May be sparse, of type "TsparseMatrix".

centered

Boolean: if TRUE, then the mean value is subtracted.

nodeSets

The name of the node sets with which this covariate is associated. If the entire data set contains more than one node set, then the node sets must be specified in all data objects.

warn

Logical: is a warning given if all values are NA, or all non-missing values are the same.

sparse

Boolean: whether a sparse matrix or not.

type

oneMode or bipartite: whether the matrix refers to a one-mode or a bipartite (two-mode) network.

Details

When part of a Siena data object, the covariate is assumed to be associated with the node sets named in nodeSets of the Siena data object. The name of the associated node sets will only be checked when the Siena data object is created.

Value

Returns the covariate as an object of class "coDyadCovar", in which form it can be used as an argument to sienaDataCreate.

Author(s)

Ruth Ripley

References

See https://www.stats.ox.ac.uk/~snijders/siena/

See Also

sienaDataCreate, varDyadCovar, coCovar, varCovar

Examples

mydyadvar <- coDyadCovar(s503)

RSiena documentation built on Nov. 2, 2023, 5:19 p.m.