RSiena (version 1.1-212)

getEffects: Function to create a Siena effects object

Description

Creates a basic list of effects for each of the dependent variables in the input siena object.

Usage

getEffects(x, nintn = 10, behNintn=4, getDocumentation=FALSE)

Value

An object of class "sienaEffects" or "sienaGroupEffects": this is a data frame, each part of which relates to one dependent variable in the input object, with columnsnamename of the dependent variableeffectNamename of the effectfunctionNamename of the functionshortNameshort name for the effectinteraction1second variable in interaction, if anyinteraction2third variable in interaction, if anytype"eval","endow", or "rate"basicRateboolean: whether a basic rate parameterincludeboolean: include or notrandomEffectsboolean: random or fixed effectfixboolean: fix value or nottestboolean: test required or nottimeDummycomma separated list of periods, or "all", or ',' for none -- which time dummy interacted parameters should be included?initialValuestarting value for estimationparmparameter valuesfunctionType"objective", "rate"periodperiod for basic rate parametersrateType"Structural", "covariate"untrimmedValueUsed to store initial values which could be trimmedeffect1Used to indicate effect number in user specified interactionseffect2Used to indicate effect number in user specified interactionseffect3Used to indicate effect number in user specified interactionsinteractionTypeDefines "dyadic" or "ego" effectseffectFnhere NULL, but could be replaced by a function laterstatisticFnhere NULL, but could be replaced by a function laternetType"oneMode", "behavior", "bipartite"groupNamename of relevant data objectgroupsequential number of relevant data object in totaleffectNumbera unique identifier of the rowThe combination of name, shortName, interaction1, interaction2, and type uniquely identifies any effect other than basic rate effects.The combination name, shortName, period and group uniquely identifies a basic rate effect.

Details

Considers all the elements of the input siena data object and creates lists of effects for use in siena model fits. Note that the class of the return object may be lost if the data.frame is edited using fix.

References

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

See Also

sienaDataCreate

Examples

mynet1 <- sienaNet(array(c(s501, s502, s503), dim=c(50, 50, 3)))
mynet2 <- sienaNet(s50a, type='behavior')
mycovar <- coCovar(rnorm(50))
mydyadcovar <- coDyadCovar(matrix(as.numeric(rnorm(2500) > 2), nrow=50))
mydata <- sienaDataCreate(mynet1, mynet2, mycovar, mydyadcovar)
myeff <- getEffects(mydata)