SEMID package documentation.

Description

SEMID provides a number of methods for testing the global/generic identifiability of mixed graphs and latent-factor graphs.

Details

The only functions you're likely to need from SEMID are semID and lfhtcID. A complete description of all package features, along with examples, can be found at https://github.com/Lucaweihs/SEMID.

Examples

###
# Checking the generic identifiability of parameters in a mixed graph.
###

# Mixed graphs are specified by their directed adjacency matrix L and
# bidirected adjacency matrix O.
L = t(matrix(
 c(0, 1, 1, 0, 0,
   0, 0, 1, 1, 1,
   0, 0, 0, 1, 0,
   0, 0, 0, 0, 1,
   0, 0, 0, 0, 0), 5, 5))

O = t(matrix(
 c(0, 0, 0, 1, 0,
   0, 0, 1, 0, 1,
   0, 0, 0, 0, 0,
   0, 0, 0, 0, 0,
   0, 0, 0, 0, 0), 5, 5)); O=O+t(O)

# Create a mixed graph object
graph = MixedGraph(L, O)

# We can plot what this mixed graph looks like, blue edges are directed
# red edges are bidirected.
plot(graph)

# Without using decomposition techniques we can't identify all nodes
# just using the half-trek criterion
htcID(graph, tianDecompose = FALSE)

# The edgewiseTSID function can show that all edges are generically
# identifiable without proprocessing with decomposition techniques
edgewiseTSID(graph, tianDecompose = FALSE)

# The above shows that all edges in the graph are generically identifiable.
# See the help of edgewiseTSID to find out more information about what
# else is returned by edgewiseTSID.

###
# Checking generic parameter identifiability using the generalGenericID
# function
###

L = t(matrix(
 c(0, 1, 0, 0, 0,
   0, 0, 0, 1, 1,
   0, 0, 0, 1, 0,
   0, 1, 0, 0, 1,
   0, 0, 0, 1, 0), 5, 5))

O = t(matrix(
 c(0, 0, 0, 0, 0,
   0, 0, 1, 0, 1,
   0, 0, 0, 1, 0,
   0, 0, 0, 0, 0,
   0, 0, 0, 0, 0), 5, 5)); O=O+t(O)

# Create a mixed graph object
graph = MixedGraph(L, O)

# Now lets define an "identification step" function corresponding to
# using the edgewise identification algorithm but with subsets
# controlled by 1.
restrictedEdgewiseIdentifyStep <- function(mixedGraph,
                                            unsolvedParents,
                                            solvedParents,
                                            identifier) {
     return(edgewiseIdentifyStep(mixedGraph, unsolvedParents,
                                 solvedParents, identifier,
                                 subsetSizeControl = 1))
}

# Now we run an identification algorithm that iterates between the
# htc and the "restricted" edgewise identification algorithm
generalGenericID(graph, list(htcIdentifyStep,
                               restrictedEdgewiseIdentifyStep),
	                 tianDecompose = FALSE)

# We can do better (fewer unsolved parents) if we don't restrict the edgewise
# identifier algorithm as much
generalGenericID(graph, list(htcIdentifyStep, edgewiseIdentifyStep),
                  tianDecompose = FALSE)

###
# Checking the generic identifiability of parameters in a latent-factor graph.
###

# Latent digraphs are specified by their directed adjacency matrix L
library(SEMID)
L = matrix(c(0, 1, 0, 0, 0, 0,
             0, 0, 1, 0, 0, 0,
             0, 0, 0, 0, 0, 0,
             0, 0, 0, 0, 1, 0,
             0, 0, 0, 0, 0, 0,
             1, 1, 1, 1, 1, 0), 6, 6, byrow=TRUE)
observedNodes = seq(1,5)
latentNodes = c(6)

# Create the latent digraph object corresponding to L
g = LatentDigraph(L, observedNodes, latentNodes)

# Plot latent digraph
plot(g)

# We can identify all nodes by the latent-factor half-trek criterion
lfhtcID(g)

Construct FlowGraph object

Description

Creates an object representing a flow graph.

Usage

FlowGraph(L = matrix(0,1,1), vertexCaps = 1, edgeCaps = matrix(1,1,1))

Arguments

Value

An object representing the FlowGraph.

Get directed adjacency matrix.

Description

Get directed adjacency matrix.

Usage

L(this, ...)

## S3 method for class 'LatentDigraphFixedOrder'
L(this, ...)

## S3 method for class 'LatentDigraph'
L(this, ...)

## S3 method for class 'MixedGraph'
L(this, ...)

Arguments

Construct a LatentDigraph object

Description

Creates an object representing a latent factor graph. The methods that are currently available to be used on the latent factor graph include

1. numObserved

2. numLatents

3. numNodes

4. toIn

5. toEx

6. L

7. observedNodes

8. latentNodes

9. parents

10. children

11. ancestors

12. descendants

13. trFrom

14. getTrekSystem

15. inducedSubgraph

16. stronglyConnectedComponent

17. plot

18. observedParents

19. getMixedGraph

see the individual function documentation for more information.

Usage

LatentDigraph(L = matrix(0,1,1),
                     observedNodes = seq(1, length = nrow(L)),
                     latentNodes = integer(0))

Arguments

Value

An object representing the LatentDigraph

Construct LatentDigraphFixedOrder object

Description

Creates an object representing a directed graph with some number of nodes which are latent (unobserved).

Usage

LatentDigraphFixedOrder(L = matrix(0,1,1), numObserved = nrow(L))

Arguments

Value

An object representing the LatentDigraphFixedOrder

Construct MixedGraph object

Description

Creates an object representing a mixed graph. The methods that are currently available to be used on the mixed graph include

1. ancestors

2. descendants

3. parents

4. siblings

5. isSibling

6. htrFrom

7. trFrom

8. getHalfTrekSystem

9. getTrekSystem

10. inducedSubgraph

11. L

12. O

13. nodes

14. numNodes

15. stronglyConnectedComponent

16. tianComponent

17. tianDecompose

see the individual function documentation for more information.

Usage

MixedGraph(
  L = matrix(0, 1, 1),
  O = matrix(0, 1, 1),
  vertexNums = seq(1, length = nrow(L))
)

Arguments

Value

An object representing the MixedGraph

Get adjacency matrix for bidirected part.

Description

Get adjacency matrix for bidirected part.

Usage

O(this, ...)

## S3 method for class 'MixedGraph'
O(this, ...)

Arguments

All ancestors of a collection of nodes

Description

Finds all the ancestors of a collection of nodes. These ancestors DO include the nodes themselves (every node is considered an ancestor of itself).

Usage

ancestors(this, nodes, ...)

## S3 method for class 'LatentDigraphFixedOrder'
ancestors(this, nodes, includeObserved = T, includeLatents = T, ...)

## S3 method for class 'LatentDigraph'
ancestors(this, nodes, includeObserved = T, includeLatents = T, ...)

## S3 method for class 'MixedGraph'
ancestors(this, nodes, ...)

Arguments

Value

the ancestors of the nodes in the observed part of the graph.

Determines which edges in a mixed graph are ancestralID-identifiable

Description

Uses the an identification criterion of Drton and Weihs (2015); this version of the algorithm is somewhat different from Drton and Weihs (2015) in that it also works on cyclic graphs. The original version of the algorithm can be found in the function graphID.ancestralID.

Usage

ancestralID(mixedGraph, tianDecompose = T)

Arguments

Value

see the return of generalGenericID.

Perform one iteration of ancestral identification.

Description

A function that does one step through all the nodes in a mixed graph and tries to determine if directed edge coefficients are generically identifiable by leveraging decomposition by ancestral subsets. See Algorithm 1 of Drton and Weihs (2015); this version of the algorithm is somewhat different from Drton and Weihs (2015) in that it also works on cyclic graphs.

Usage

ancestralIdentifyStep(mixedGraph, unsolvedParents, solvedParents, identifier)

Arguments

Value

a list with four components:

identifiedEdges

a matrix rx2 matrix where r is the number of edges that where identified by this function call and identifiedEdges[i,1] -> identifiedEdges[i,2] was the ith edge identified

unsolvedParents

as the input argument but updated with any newly identified edges

solvedParents

as the input argument but updated with any newly identified edges

identifier

as the input argument but updated with any newly identified edges

References

Drton, M. and Weihs, L. (2015) Generic Identifiability of Linear Structural Equation Models by Ancestor Decomposition. arXiv 1504.02992

Get bidirected components of a mixed graph

Description

Returns induced subgraphs of connected bidirected components with more than 1 node.

Usage

bidirectedComponents(graph)

Arguments

Value

list, where each object is a MixedGraph with at least two nodes.

All children of a collection of nodes.

Description

Returns all children of the collection (does not necessarily include the input nodes themselves unless they are parents of one another).

Usage

children(this, nodes, ...)

## S3 method for class 'LatentDigraphFixedOrder'
children(this, nodes, includeObserved = T, includeLatents = T, ...)

## S3 method for class 'LatentDigraph'
children(this, nodes, includeObserved = T, includeLatents = T, ...)

## S3 method for class 'MixedGraph'
children(this, nodes, ...)

Arguments

Value

the observed children

Create an ancestral identification function.

Description

A helper function for ancestralIdentifyStep, creates an identifier function based on its given parameters. This created identifier function will identify the directed edges from 'targets' to 'node.'

Usage

createAncestralIdentifier(
  idFunc,
  sources,
  targets,
  node,
  htrSources,
  ancestralSubset,
  cComponent
)

Arguments

Value

an identification function

Create an edgewise identification function

Description

A helper function for edgewiseIdentifyStep, creates an identifier function based on its given parameters. This created identifier function will identify the directed edges from 'targets' to 'node.'

Usage

createEdgewiseIdentifier(
  idFunc,
  sources,
  targets,
  node,
  solvedNodeParents,
  sourceParentsToRemove
)

Arguments

Value

an identification function

Create an htc identification function.

Description

A helper function for htcIdentifyStep, creates an identifier function based on its given parameters. This created identifier function will identify the directed edges from 'targets' to 'node.'

Usage

createHtcIdentifier(idFunc, sources, targets, node, htrSources)

Arguments

Value

an identification function

References

Foygel, R., Draisma, J., and Drton, M. (2012) Half-trek criterion for generic identifiability of linear structural equation models. Ann. Statist. 40(3): 1682-1713.

Create an identifier base case

Description

Identifiers are functions that take as input a covariance matrix Sigma corresponding to some mixed graph G and, from that covariance matrix, identify some subset of the coefficients in the mixed graph G. This function takes as input the matrices, L and O, defining G and creates an identifier that does not identify any of the coefficients of G. This is useful as a base case when building more complex identification functions.

Usage

createIdentifierBaseCase(L, O)

Arguments

Value

a function that takes as input a covariance matrix compatible with the mixed graph defined by L/O and returns a list with two named components:

Lambda

a matrix equal to L but with NA values instead of 1s

Omega

a matrix equal to O but with NA values instead of 1s

When building more complex identifiers these NAs will be replaced by the value that can be identified from Sigma.

Create a latent-factor half-trek critierion identification function.

Description

A helper function for lfhtcIdentifyStep, creates an identifier function based on its given parameters. This created identifier function will identify the directed edges from 'targets' to 'node.'

Usage

createLFHtcIdentifier(idFunc, v, Y, Z, parents, reachableY)

Arguments

Value

an identification function

References

Barber, R. F., Drton, M., Sturma, N., and Weihs L. (2022). Half-Trek Criterion for Identifiability of Latent Variable Models. arXiv preprint arXiv:2201.04457

Create an latent identifier base case

Description

Identifiers are functions that take as input a covariance matrix Sigma corresponding to some latent digraph G and, from that covariance matrix, identify some subset of the coefficients coresponding to the direct causal effects in the latent digraph G. This function takes as input the digraph G and creates an identifier that does not identify any of the direct causal effects. This is useful as a base case when building more complex identification functions.

Usage

createLFIdentifierBaseCase(graph)

Arguments

Value

a function that takes as input a covariance matrix compatible with the latent digraph defined by L and returns a list with two named components:

Lambda

a matrix equal to the observed part of graph$L() but with NA values instead of 1s

Omega

a matrix equal to graph$O() but with NA values for coefficients not equal to zero.

When building more complex identifiers these NAs will be replaced by the value that can be identified from the covariance matrix corresponding to G.

Identify bidirected edges if all directed edges are identified

Description

Creates an identifier function that assumes that all directed edges have already been identified and then is able to identify all bidirected edges simultaneously.

Usage

createSimpleBiDirIdentifier(idFunc)

Arguments

Value

a new identifier function that identifies everything.

Helper function to create a graph encoding trek reachable relationships.

Description

Helper function to create a graph encoding trek reachable relationships.

Usage

createTrGraph(this, ...)

## S3 method for class 'LatentDigraphFixedOrder'
createTrGraph(this, ...)

Arguments

Helper function to create a flow graph.

Description

Helper function to create a flow graph.

Usage

createTrekFlowGraph(this, ...)

## S3 method for class 'LatentDigraphFixedOrder'
createTrekFlowGraph(this, ...)

Arguments

Create an trek separation identification function

Description

A helper function for trekSeparationIdentifyStep, creates an identifier function based on its given parameters. This created identifier function will identify the directed edge from 'parent' to 'node.'

Usage

createTrekSeparationIdentifier(
  idFunc,
  sources,
  targets,
  node,
  parent,
  solvedParents
)

Arguments

Value

an identification function

Get descendants of a collection of observed nodes

Description

Finds all descendants of a collection of nodes, this DOES include the nodes themselves (every node is considered a descendant of itself).

Usage

descendants(this, nodes, ...)

## S3 method for class 'LatentDigraphFixedOrder'
descendants(this, nodes, includeObserved = T, includeLatents = T, ...)

## S3 method for class 'LatentDigraph'
descendants(this, nodes, includeObserved = T, includeLatents = T, ...)

## S3 method for class 'MixedGraph'
descendants(this, nodes, ...)

Arguments

Determines which edges in a mixed graph are edgewiseID-identifiable

Description

Uses the edgewise identification criterion of Weihs, Robeva, Robinson, et al. (2017) to determine which edges in a mixed graph are generically identifiable.

Usage

edgewiseID(mixedGraph, tianDecompose = T, subsetSizeControl = 3)

Arguments

Value

see the return of generalGenericID.

Perform one iteration of edgewise identification.

Description

A function that does one step through all the nodes in a mixed graph and tries to identify new edge coefficients using the existence of half-trek systems as described in Weihs, Robeva, Robinson, et al. (2017).

Usage

edgewiseIdentifyStep(
  mixedGraph,
  unsolvedParents,
  solvedParents,
  identifier,
  subsetSizeControl = Inf
)

Arguments

Value

see the return of htcIdentifyStep.

Determines which edges in a mixed graph are edgewiseID+TS identifiable

Description

Uses the edgewise+TS identification criterion of Weihs, Robeva, Robinson, et al. (2017) to determine which edges in a mixed graph are generically identifiable. In particular this algorithm iterates between the half-trek, edgewise, and trek-separation identification algorithms in an attempt to identify as many edges as possible, this may be very slow.

Usage

edgewiseTSID(
  mixedGraph,
  tianDecompose = T,
  subsetSizeControl = 3,
  maxSubsetSize = 3
)

Arguments

Value

see the return of generalGenericID.

Flow from one set of nodes to another.

Description

Flow from one set of nodes to another.

Usage

flowBetween(this, sources, sinks)

## S3 method for class 'FlowGraph'
flowBetween(this, sources, sinks)

Arguments

Value

a list with two named components, value (the size of the computed flow) and activeSources (a vector representing the subset of sources which have non-zero flow out of them for the found max-flow).

A general generic identification algorithm template.

Description

A function that encapsulates the general structure of our algorithms for testing generic identifiability. Allows for various identification algorithms to be used in concert, in particular it will use the identifier functions in the list idStepFunctions sequentially until it can find no more identifications. The step functions that are currently available for use in idStepFunctions are

1. htcIdentifyStep,

2. ancestralIdentifyStep,

3. edgewiseIdentifyStep,

4. trekSeparationIdentifyStep.

Usage

generalGenericID(mixedGraph, idStepFunctions, tianDecompose = T)

Arguments

Value

returns an object of class 'GenericIDResult,' this object is just a list with 9 components:

solvedParents

a list whose ith element contains a vector containing the subsets of parents of node i for which the edge j->i could be shown to be generically identifiable.

unsolvedParents

as for solvedParents but for the unsolved parents.

solvedSiblings

as for solvedParents but for the siblings of node i (i.e. the bidirected neighbors of i).

unsolvedSiblings

as for solvedSilbings but for the unsolved siblings of node i (i.e. the bidirected neighbors of i).

identifier

a function that takes a (generic) covariance matrix corresponding to the graph and identifies the edges parameters from solvedParents and solvedSiblings. See htcIdentifyStep for a more in-depth discussion of identifier functions.

mixedGraph

a mixed graph object of the graph.

idStepFunctions

a list of functions used to generically identify parameters. For instance, htcID uses the function htcIdentifyStep to identify edges.

tianDecompose

the argument tianDecompose.

call

the call made to this function.

Get getAncestors of nodes in a graph.

Description

Get the getAncestors of a collection of nodes in a graph g, the getAncestors DO include the the nodes themselves.

Usage

getAncestors(g, nodes)

Arguments

Value

a sorted vector of all ancestor nodes.

Get descendants of nodes in a graph.

Description

Gets the descendants of a collection of nodes in a graph (all nodes that can be reached by following directed edges from those nodes). Descendants DO include the nodes themselves.

Usage

getDescendants(g, nodes)

Arguments

Value

a sorted vector of all descendants of nodes.

Determines if a half-trek system exists in the mixed graph.

Description

Determines if a half-trek system exists in the mixed graph.

Usage

getHalfTrekSystem(this, fromNodes, toNodes, ...)

## S3 method for class 'MixedGraph'
getHalfTrekSystem(
  this,
  fromNodes,
  toNodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  avoidRightEdges = integer(0),
  ...
)

## S3 method for class 'MixedGraph'
getTrekSystem(
  this,
  fromNodes,
  toNodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  avoidLeftEdges = integer(0),
  avoidRightEdges = integer(0),
  ...
)

Arguments

Value

a list with two named components, systemExists (TRUE if a system exists, FALSE otherwise) and activeFrom (the subset of fromNodes from which the maximal half-trek system was started).

Size of largest HT system Y satisfying the HTC for a node v except perhaps having |getParents(v)| < |Y|.

Description

For an input mixed graph H, constructs the Gflow graph as described in Foygel et al. (2012) for a subgraph G of H. A max flow algorithm is then run on Gflow to determine the largest half-trek system in G to a particular node's getParents given a set of allowed nodes. Here G should consist of a bidirected part and nodes which are not in the bidirected part but are a parent of some node in the bidirected part. G should contain the node for which to compute the max flow.

Usage

getMaxFlow(L, O, allowedNodes, biNodes, inNodes, node)

Arguments

Value

See title.

References

Foygel, R., Draisma, J., and Drton, M. (2012) Half-trek criterion for generic identifiability of linear structural equation models. Ann. Statist. 40(3): 1682-1713.

Get the mixed component of a node in a mixed subgraph.

Description

For an input mixed graph H and set of nodes A, let GA be the subgraph of H on the nodes A. This function returns the mixed component of GA containing a specified node.

Usage

getMixedCompForNode(dG, bG, subNodes, node)

Arguments

Value

a list with two named elements: biNodes - the nodes of the mixed graph in the biDirected component containing nodeName w.r.t the ancestral set of nodes inNodes - the nodes in the graph which are not part of biNodes but which are a parent of some node in biNodes.

Get the corresponding mixed graph

Description

Only works for graphs where the latent nodes are source nodes

Usage

getMixedGraph(this, ...)

## S3 method for class 'LatentDigraph'
getMixedGraph(this, ...)

Arguments

Get getParents of nodes in a graph.

Description

Get the getParents of a collection of nodes in a graph g, the getParents DO include the input nodes themselves.

Usage

getParents(g, nodes)

Arguments

Value

a sorted vector of all parent nodes.

Get getSiblings of nodes in a graph.

Description

Get the getSiblings of a collection of nodes in a graph g, the getSiblings DO include the input nodes themselves.

Usage

getSiblings(g, nodes)

Arguments

Value

a sorted vector of all getSiblings of nodes.

Determines if a trek system exists in the mixed graph.

Description

Determines if a trek system exists in the mixed graph.

Usage

getTrekSystem(
  this,
  fromNodes,
  toNodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  avoidLeftEdges = integer(0),
  avoidRightEdges = integer(0),
  ...
)

## S3 method for class 'LatentDigraphFixedOrder'
getTrekSystem(
  this,
  fromNodes,
  toNodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  avoidLeftEdges = integer(0),
  avoidRightEdges = integer(0),
  ...
)

## S3 method for class 'LatentDigraph'
getTrekSystem(
  this,
  fromNodes,
  toNodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  avoidLeftEdges = integer(0),
  avoidRightEdges = integer(0),
  ...
)

Arguments

Determines whether a mixed graph is globally identifiable.

Description

Uses the criterion in Theorem 2 of the paper by Drton, Foygel and Sullivant (2011) to determine whether a mixed graph is globally identifiable.

Usage

globalID(graph)

Arguments

Value

TRUE if the graph is globally identifiable, FALSE otherwise.

References

Drton, M., Barber, R. F., and Sullivant S. (2011). Half-Trek Criterion for Identifiability of Latent Variable Models. Ann. Statist. 39 (2011), no. 2, 865–886 <doi:10.1214/10-AOS859>.

Identifiability of linear structural equation models.

Description

NOTE: graphID has been deprecated, use semID instead.

This function checks global and generic identifiability of linear structural equation models. For generic identifiability the function checks a sufficient criterion as well as a necessary criterion but this check may be inconclusive.

Usage

graphID(
  L,
  O,
  output.type = "matrix",
  file.name = NULL,
  decomp.if.acyclic = TRUE,
  test.globalID = TRUE,
  test.genericID = TRUE,
  test.nonID = TRUE
)

Arguments

Value

A list or printed matrix indicating the identifiability status of the linear SEM given by the input graph. Optionally the graph's components are listed.

With output.type = 'list', the function returns a list of components for the graph. Each list entry is again a list that indicates first which nodes form the component and second whether the component forms a mixed graph that is acyclic. The next entries in the list show HTC-identifiable nodes, meaning nodes v for which the coefficients for all the directed edges pointing to v can be identified using the methods from Foygel et al. (2012). The HTC-identifiable nodes are listed in the order in which they are found by the recursive identification algorithm. The last three list entries are logical values that indicate whether or not the graph component is generically identifiable, globally identifiable or not identifiable; compare Drton et al. (2011) and Foygel et al. (2012). In the latter case the Jacobian of the parametrization does not have full rank.

With output.type = 'matrix', a summary of the above information is printed.

References

Drton, M., Foygel, R., and Sullivant, S. (2011) Global identifiability of linear structural equation models. Ann. Statist. 39(2): 865-886.

Foygel, R., Draisma, J., and Drton, M. (2012) Half-trek criterion for generic identifiability of linear structural equation models. Ann. Statist. 40(3): 1682-1713.

Examples

## Not run: 
L = t(matrix(
  c(0, 1, 0, 0, 0,
    0, 0, 1, 0, 0,
    0, 0, 0, 1, 0,
    0, 0, 0, 0, 1,
    0, 0, 0, 0, 0), 5, 5))
O = t(matrix(
  c(0, 0, 1, 1, 0,
    0, 0, 0, 1, 1,
    0, 0, 0, 0, 0,
    0, 0, 0, 0, 0,
    0, 0, 0, 0, 0), 5, 5))
O=O+t(O)
graphID(L,O)


## Examples from Foygel, Draisma & Drton (2012)
demo(SEMID)

## End(Not run)

Determine generic identifiability of an acyclic mixed graph using ancestral decomposition.

Description

For an input, acyclic, mixed graph attempts to determine if the graph is generically identifiable using decomposition by ancestral subsets. See algorithm 1 of Drton and Weihs (2015).

Usage

graphID.ancestralID(L, O)

Arguments

Value

The vector of nodes that could be determined to be generically identifiable using the above algorithm.

References

Drton, M. and Weihs, L. (2015) Generic Identifiability of Linear Structural Equation Models by Ancestor Decomposition. arXiv 1504.02992

Determine generic identifiability by Tian Decomposition and HTC

Description

Split a graph into mixed Tian components and solve each separately using the HTC.

Usage

graphID.decompose(
  L,
  O,
  decomp.if.acyclic = TRUE,
  test.globalID = TRUE,
  test.genericID = TRUE,
  test.nonID = TRUE
)

Arguments

Value

A list with two named components:

1. Components - a list of lists. Each list represents one mixed Tian component of the graph. Each list contains named components corresponding to which nodes are in the component and results of various tests of identifiability on the component (see the parameter descriptions).

2. Decomp - true if a decomposition occured, false if not.

Determine generic identifiability of a mixed graph.

Description

If the directed part of input graph is cyclic then will check for generic identifiability using the half-trek criterion. Otherwise will use the a slightly stronger version of the half-trek criterion using ancestor decompositions.

Usage

graphID.genericID(L, O)

Arguments

Value

The vector of nodes that could be determined to be generically identifiable.

References

Foygel, R., Draisma, J., and Drton, M. (2012) Half-trek criterion for generic identifiability of linear structural equation models. Ann. Statist. 40(3): 1682-1713.

Drton, M. and Weihs, L. (2015) Generic Identifiability of Linear Structural Equation Models by Ancestor Decomposition. arXiv 1504.02992

Determines if a mixed graph is HTC-identifiable.

Description

Uses the half-trek criterion of Foygel, Draisma, and Drton (2013) to check if an input mixed graph is generically identifiable.

Usage

graphID.htcID(L, O)

Arguments

Value

The vector of HTC-identifiable nodes.

References

Foygel, R., Draisma, J., and Drton, M. (2012) Half-trek criterion for generic identifiability of linear structural equation models. Ann. Statist. 40(3): 1682-1713.

Helper function to handle a graph component.

Description

Calls the other functions that determine identifiability status.

Usage

graphID.main(
  L,
  O,
  test.globalID = TRUE,
  test.genericID = TRUE,
  test.nonID = TRUE
)

Arguments

Value

A list containing named components of the results of various tests desired based on the input parameters.

Check for generic infinite-to-one via the half-trek criterion.

Description

Checks if a mixed graph is infinite-to-one using the half-trek criterion presented by Foygel, Draisma, and Drton (2012).

Usage

graphID.nonHtcID(L, O)

Arguments

Value

TRUE if the graph could be determined to be generically non-identifiable, FALSE if this test was inconclusive.

References

Foygel, R., Draisma, J., and Drton, M. (2012) Half-trek criterion for generic identifiability of linear structural equation models. Ann. Statist. 40(3): 1682-1713.

Determines which edges in a mixed graph are HTC-identifiable.

Description

Uses the half-trek criterion of Foygel, Draisma, and Drton (2012) determine which edges in a mixed graph are generically identifiable. Depending on your application it faster to use the graphID.htcID function instead of this one, this function has the advantage of returning additional information.

Usage

htcID(mixedGraph, tianDecompose = T)

Arguments

Value

see the return value of generalGenericID.

References

Foygel, R., Draisma, J., and Drton, M. (2012) Half-trek criterion for generic identifiability of linear structural equation models. Ann. Statist. 40(3): 1682-1713.

Jin Tian. 2005. Identifying direct causal effects in linear models. In Proceedings of the 20th national conference on Artificial intelligence - Volume 1 (AAAI'05), Anthony Cohn (Ed.), Vol. 1. AAAI Press 346-352.

Perform one iteration of HTC identification.

Description

A function that does one step through all the nodes in a mixed graph and tries to identify new edge coefficients using the existence of half-trek systems as described in Foygel, Draisma, Drton (2012).

Usage

htcIdentifyStep(mixedGraph, unsolvedParents, solvedParents, identifier)

Arguments

Value

a list with four components:

identifiedEdges

a matrix rx2 matrix where r is the number of edges that where identified by this function call and identifiedEdges[i,1] -> identifiedEdges[i,2] was the ith edge identified

unsolvedParents

as the input argument but updated with any newly identified edges

solvedParents

as the input argument but updated with any newly identified edges

identifier

as the input argument but updated with any newly identified edges

References

Foygel, R., Draisma, J., and Drton, M. (2012) Half-trek criterion for generic identifiability of linear structural equation models. Ann. Statist. 40(3): 1682-1713

Get all HTR nodes from a set of nodes in a graph.

Description

Gets all vertices in a graph that are half-trek reachable from a set of nodes. WARNING: Often the half-trek reachable nodes from a vertex v are defined to not include the vertex v or its getSiblings. We DO NOT follow this convention, the returned set will include input nodes and their getSiblings.

Usage

htr(dG, bG, nodes)

Arguments

Value

a sorted list of all half-trek reachable nodes.

Half trek reachable nodes.

Description

Half trek reachable nodes.

Usage

htrFrom(this, nodes, ...)

## S3 method for class 'MixedGraph'
htrFrom(
  this,
  nodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  ...
)

Arguments

Value

a vector of all nodes half-trek reachable from node.

Get the induced subgraph on a collection of nodes

Description

Get the induced subgraph on a collection of nodes

Usage

inducedSubgraph(this, nodes, ...)

## S3 method for class 'LatentDigraph'
inducedSubgraph(this, nodes, ...)

## S3 method for class 'MixedGraph'
inducedSubgraph(this, nodes, ...)

Arguments

Are two nodes siblings?

Description

Are two nodes siblings?

Usage

isSibling(this, node1, node2, ...)

## S3 method for class 'MixedGraph'
isSibling(this, node1, node2, ...)

Arguments

Value

TRUE if the nodes are siblings in the graph, FALSE otherwise

Checks that a LatentDigraph has appropriate node numbering

Description

Checks that the input latent digraph has nodes numbered from 1 to latentDigraph$numObserved()+latentDigraph$numLatents(). The first latentDigraph$numObserved() nodes correspond to the observed nodes in the graph, all other nodes are considered unobserved. Throws an error if this is not true.

Usage

latentDigraphHasSimpleNumbering(graph)

Arguments

Get all latent nodes in the graph.

Description

Get all latent nodes in the graph.

Usage

latentNodes(this, ...)

## S3 method for class 'LatentDigraph'
latentNodes(this, ...)

Arguments

Determines which edges in a latent digraph are LF-HTC-identifiable.

Description

Uses the latent-factor half-trek criterion to determine which edges in a latent digraph are generically identifiable.

Usage

lfhtcID(graph)

Arguments

Value

returns a list with 8 components:

solvedParents

a list whose ith element contains a vector containing the subsets of parents of node i for which the edge j->i could be shown to be generically identifiable.

unsolvedParents

as for solvedParents but for the unsolved parents.

identifier

a function that takes a (generic) covariance matrix corresponding to the graph and identifies the edges parameters from solvedParents and solvedSiblings. See htcIdentifyStep for a more in-depth discussion of identifier functions.

graph

a latent digraph object of the graph.

call

the call made to this function.

activeFroms

list. If node i is solved then the ith index is a vector containing the nodes Y otherwise it is empty.

Zs

list. If node i is solved then the ith index is a vector containing the nodes Z otherwise it is empty.

Ls

list. If node i is solved then the ith index is a vector containing the nodes L otherwise it is empty.

References

Barber, R. F., Drton, M., Sturma, N., and Weihs L. (2022). Half-Trek Criterion for Identifiability of Latent Variable Models. Ann. Statist. 50(6):3174–3196. <doi:10.1214/22-AOS2221>.

Perform one iteration of latent-factor HTC identification.

Description

A function that does one step through all the nodes in a latent-factor graph and tries to identify new edge coefficients using the existence of latent-factor half-trek systems.

Usage

lfhtcIdentifyStep(
  graph,
  unsolvedParents,
  solvedParents,
  activeFroms,
  Zs,
  Ls,
  identifier,
  subsetSizeControl = Inf
)

Arguments

Value

a list with four components:

identifiedEdges

a matrix rx2 matrix where r is the number of edges that where identified by this function call and identifiedEdges[i,1] -> identifiedEdges[i,2] was the ith edge identified

unsolvedParents

as the input argument but updated with any newly identified edges

solvedParents

as the input argument but updated with any newly identified edges

identifier

as the input argument but updated with any newly identified edges

activeFroms

as the input argument but updated with any newly solved node

Zs

as the input argument but updated with any newly solved node

Ls

as the input argument but updated with any newly solved node

References

Barber, R. F., Drton, M., Sturma, N., and Weihs L. (2022). Half-Trek Criterion for Identifiability of Latent Variable Models. arXiv preprint arXiv:2201.04457

Checks that a MixedGraph has appropriate node numbering

Description

Checks that the input mixed graph has vertices are numbered from 1 to mixedGraph$numNodes(). Throws an error if they are not.

Usage

mixedGraphHasSimpleNumbering(mixedGraph)

Arguments

Get all nodes in the graph.

Description

Get all nodes in the graph.

Usage

nodes(this, ...)

## S3 method for class 'MixedGraph'
nodes(this, ...)

Arguments

Number of latent nodes in the graph.

Description

Number of latent nodes in the graph.

Usage

numLatents(this, ...)

## S3 method for class 'LatentDigraphFixedOrder'
numLatents(this, ...)

## S3 method for class 'LatentDigraph'
numLatents(this, ...)

Arguments

Number of nodes in the graph.

Description

Number of nodes in the graph.

Usage

numNodes(this, ...)

## S3 method for class 'LatentDigraphFixedOrder'
numNodes(this, ...)

## S3 method for class 'LatentDigraph'
numNodes(this, ...)

## S3 method for class 'MixedGraph'
numNodes(this, ...)

Arguments

Number of observed nodes in the graph.

Description

Number of observed nodes in the graph.

Usage

numObserved(this, ...)

## S3 method for class 'LatentDigraphFixedOrder'
numObserved(this, ...)

## S3 method for class 'LatentDigraph'
numObserved(this, ...)

Arguments

Get all observed nodes in the graph.

Description

Get all observed nodes in the graph.

Usage

observedNodes(this, ...)

## S3 method for class 'LatentDigraph'
observedNodes(this, ...)

Arguments

Get the observed parents on a collection of nodes

Description

Get the observed parents on a collection of nodes

Usage

observedParents(this, nodes, ...)

## S3 method for class 'LatentDigraph'
observedParents(this, nodes, ...)

Arguments

All parents of a collection of nodes.

Description

Returns all parents of the collection (does not necessarily include the input nodes themselves unless they are parents of one another).

Usage

parents(this, nodes, ...)

## S3 method for class 'LatentDigraphFixedOrder'
parents(this, nodes, includeObserved = T, includeLatents = T, ...)

## S3 method for class 'LatentDigraph'
parents(this, nodes, includeObserved = T, includeLatents = T, ...)

## S3 method for class 'MixedGraph'
parents(this, nodes, ...)

Arguments

Value

the observed parents.

Plots the latent digraph

Description

Plots the latent digraph

Plots the mixed graph

Usage

## S3 method for class 'LatentDigraph'
plot(x, ...)

## S3 method for class 'MixedGraph'
plot(x, ...)

Arguments

Plot a latent factor graph

Description

Given an adjacency matrix representing the directed edges in a latent factor graph, plots a representation of the graph. The latent nodes should come last in L and the vertex labels should only be given for the observed nodes.

Usage

plotLatentDigraph(L, observedNodes, latentNodes, main = "")

Arguments

Value

An object representing the LatentDigraph

Plot a mixed graph

Description

Given adjacency matrices representing the directed and bidirected portions of a mixed graph, plots a representation of the graph.

Usage

plotMixedGraph(L, O, main = "", vertexLabels = 1:nrow(L))

Arguments

Prints a GenericIDResult object

Description

Prints a GenericIDResult object as returned by generalGenericID. Invisibly returns its argument via invisible(x) as most print functions do.

Usage

## S3 method for class 'GenericIDResult'
print(x, ...)

Arguments

Prints a LfhtcIDResult object

Description

Prints a LfhtcIDResult object as returned by lfhtcID. Invisibly returns its argument via invisible(x) as most print functions do.

Usage

## S3 method for class 'LfhtcIDResult'
print(x, ...)

Arguments

Prints a SEMIDResult object

Description

Prints a SEMIDResult object as returned by semID. Invisibly returns its argument via invisible(x) as most print functions do.

Usage

## S3 method for class 'SEMIDResult'
print(x, ...)

Arguments

Identifiability of linear structural equation models.

Description

This function can be used to check global and generic identifiability of linear structural equation models (L-SEMs). In particular, this function takes a MixedGraph object corresponding to the L-SEM and checks different conditions known for global and generic identifiability.

Usage

semID(
  mixedGraph,
  testGlobalID = TRUE,
  testGenericNonID = TRUE,
  genericIdStepFunctions = list(htcIdentifyStep),
  tianDecompose = TRUE
)

Arguments

Value

returns an object of class 'SEMIDResult,' this object is just a list with 6 components:

isGlobalID

If testGlobalID == TRUE, then TRUE or FALSE if the graph is globally identifiable. If testGlobalID == FALSE then NA.

isGenericNonID

If testGenericNonID == TRUE, then TRUE if the graph is generically non-identifiable or FALSE the test is inconclusive. If testGenericNonID == FALSE then NA.

genericIDResult

If length(genericIdStepFunctions) != 0 then a GenericIDResult object as returned by generalGenericID. Otherwise a list of length 0.

mixedGraph

the inputted mixed graph object.

tianDecompose

the argument tianDecompose.

call

the call made to this function.

Examples

## Not run: 
L = t(matrix(
  c(0, 1, 0, 0, 0,
    0, 0, 1, 0, 0,
    0, 0, 0, 1, 0,
    0, 0, 0, 0, 1,
    0, 0, 0, 0, 0), 5, 5))
O = t(matrix(
  c(0, 0, 1, 1, 0,
    0, 0, 0, 1, 1,
    0, 0, 0, 0, 0,
    0, 0, 0, 0, 0,
    0, 0, 0, 0, 0), 5, 5))
O = O + t(O)
graph = MixedGraph(L,O)
semID(graph)

## Examples from Foygel, Draisma & Drton (2012)
demo(SEMID)

## End(Not run)

All siblings of a collection of nodes

Description

All siblings of a collection of nodes

Usage

siblings(this, nodes, ...)

## S3 method for class 'MixedGraph'
siblings(this, nodes, ...)

Arguments

Value

a vector of all of the siblings.

Strongly connected component

Description

Get the strongly connected component for a node i in the graph the graph.

Usage

stronglyConnectedComponent(this, node, ...)

## S3 method for class 'LatentDigraphFixedOrder'
stronglyConnectedComponent(this, node, ...)

## S3 method for class 'LatentDigraph'
stronglyConnectedComponent(this, node, ...)

## S3 method for class 'MixedGraph'
stronglyConnectedComponent(this, node, ...)

Arguments

Returns all subsets of a certain size

Description

For an input vector x, returns in a list, the collection of all subsets of x of size k.

Usage

subsetsOfSize(x, k)

Arguments

Value

a list of all subsets of x of a given size k

Returns the Tian c-component of a node

Description

Returns the Tian c-component of a node

Usage

tianComponent(this, node)

## S3 method for class 'MixedGraph'
tianComponent(this, node)

Arguments

Performs the tian decomposition on the mixed graph

Description

Uses the Tian decomposition to break the mixed graph into c-components. These c-components are slightly different than those from Tian (2005) in that if they graph is not acyclic the bidirected components are combined whenever they are connected by a directed loop.

Usage

tianDecompose(this)

## S3 method for class 'MixedGraph'
tianDecompose(this)

Arguments

References

Jin Tian. 2005. Identifying direct causal effects in linear models. In Proceedings of the 20th national conference on Artificial intelligence - Volume 1 (AAAI'05), Anthony Cohn (Ed.), Vol. 1. AAAI Press 346-352.

Identifies components in a tian decomposition

Description

Creates an identification function which combines the identification functions created on a collection of c-components into a identification for the full mixed graph.

Usage

tianIdentifier(idFuncs, cComponents)

Arguments

Value

a new identifier function

Globally identify the covariance matrix of a C-component

Description

The Tian decomposition of a mixed graph G allows one to globally identify the covariance matrices Sigma' of special subgraphs of G called c-components. This function takes the covariance matrix Sigma corresponding to G and a collection of node sets which specify the c-component, and returns the Sigma' corresponding to the c-component.

Usage

tianSigmaForComponent(Sigma, internal, incoming, topOrder)

Arguments

Value

the new Sigma corresponding to the c-component

Transforms a vector of node indices in the internal rep. into external numbering

Description

Transforms a vector of node indices in the internal rep. into external numbering

Usage

toEx(this, nodes, ...)

## S3 method for class 'LatentDigraph'
toEx(this, nodes, ...)

## S3 method for class 'MixedGraph'
toEx(this, nodes, ...)

Arguments

Transforms a vector of given node indices into their internal numbering

Description

Transforms a vector of given node indices into their internal numbering

Usage

toIn(this, nodes, ...)

## S3 method for class 'LatentDigraph'
toIn(this, nodes, ...)

## S3 method for class 'MixedGraph'
toIn(this, nodes, ...)

Arguments

Trek reachable nodes.

Description

Gets all nodes that are trek reachable from a collection of nodes.

Usage

trFrom(this, nodes, ...)

## S3 method for class 'LatentDigraphFixedOrder'
trFrom(
  this,
  nodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  includeObserved = T,
  includeLatents = T,
  ...
)

## S3 method for class 'LatentDigraph'
trFrom(
  this,
  nodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  includeObserved = T,
  includeLatents = T,
  ...
)

## S3 method for class 'MixedGraph'
trFrom(
  this,
  nodes,
  avoidLeftNodes = integer(0),
  avoidRightNodes = integer(0),
  ...
)

Arguments

Perform one iteration of trek separation identification.

Description

A function that does one step through all the nodes in a mixed graph and tries to identify new edge coefficients using trek-separation as described in Weihs, Robeva, Robinson, et al. (2017).

Usage

trekSeparationIdentifyStep(
  mixedGraph,
  unsolvedParents,
  solvedParents,
  identifier,
  maxSubsetSize = 3
)

Arguments

Value

see the return of htcIdentifyStep.

Update edge capacities.

Description

Update edge capacities.

Usage

updateEdgeCapacities(this, edges, newCaps)

## S3 method for class 'FlowGraph'
updateEdgeCapacities(this, edges, newCaps)

Arguments

Update vertex capacities.

Description

Update vertex capacities.

Usage

updateVertexCapacities(this, vertices, newCaps)

## S3 method for class 'FlowGraph'
updateVertexCapacities(this, vertices, newCaps)

Arguments

A helper function to validate that latent nodes in a LatentDigraph are sources.

Description

Produces an error if not all latent nodes are sources.

Usage

validateLatentNodesAreSources(graph)

Arguments

A helper function to validate input matrices.

Description

This helper function validates that the two input matrices, L and O, are of the appropriate form to be interpreted by the other functions. In particular they should be square matrices of 1's and 0's with all 0's along their diagonals. We do not require O to be symmetric here.

Usage

validateMatrices(L, O)

Arguments

Value

This function has no return value.

A helper function to validate an input matrix.

Description

This helper function validates that an input matrix, L, is of the the appropriate form to be interpreted by the other functions. In particular it should be square matrix of 1's and 0's with all 0's along its diagonal. If any of the above conditions is not met, this function will throw an error.

Usage

validateMatrix(L)

Arguments

Value

No return value

A helper function to validate if input nodes are valid.

Description

Produces an error if outside bounds.

Usage

validateNodes(nodes, numNodes)

Arguments

A helper function to validate that there are no variable arguments

Description

Produces an error if there are variable arguments.

Usage

validateVarArgsEmpty(...)

Arguments