newFactor {dynamicGraph}R Documentation

The factor vertex object

Description

Returns an object of the class containing the class FactorVertexProto.

Usage

newFactor(vertex.indices, vertices = NULL, 
          name = ifelse(is.null(vertices), "", 
                        paste(Labels(vertices), collapse = ":")),
          label = name, type = "Generator",
          index = 0, width = 2, color = "default",
          factorClasses = validFactorClasses())

Arguments

vertex.indices Integer vector of the vertex.indices of the vertices of the factor.
vertices The vertices of the factor. Used for setting the default label.
name Text string for the name of the factor vertex.
label Text string for the label of the factor vertex.
type Text string for the type, e.i. the class, of the factor vertex. Should be in factorClasses.
index Integer for the index of the factor vertex.
width Numeric, for the width of the factor vertex.
color Text string for the color of the factor vertex.
factorClasses The valid factorClasses.

Value

A object of class containing FactorVertexProto.

Note

The methods (except stratum) of VertexProto also applies for FactorVertexProto.

Author(s)

Jens Henrik Badsberg

See Also

newVertex, validVertexClasses

Examples

vertices <- returnVertexList(paste("V", 1:4, sep = ""), 
                             types = rep("Discrete", 4))
factor <- newFactor(c(1, 2, 3), vertices[1:3], type = "Generator")

str(factor)

color(factor)
label(factor)
labelPosition(factor)
name(factor)
index(factor)
position(factor)
nodeIndices(factor)

color(factor) <- "green"
label(factor) <- "v-1-2-3"
labelPosition(factor) <- c(1, 2, 3)
name(factor) <- "V-123" 
index(factor) <- 3
position(factor) <- c( 10,  20,  30,  40)

str(factor)

[Package Contents]