pcalg: fciAlgo-class – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

fciAlgo-class

Class "fciAlgo" of FCI Algorithm Results

Description

This class of objects is returned by functions fci(), rfci(), fciPlus, and dag2pag and represent the estimated PAG (and sometimes properties of the algorithm). Objects of this class have methods for the functions plot, show and summary.

Usage

## S4 method for signature 'fciAlgo'
show(object)
## S3 method for class 'fciAlgo'
print(x, amat = FALSE, zero.print = ".", ...)

## S4 method for signature 'fciAlgo'
summary(object, amat = TRUE, zero.print = ".", ...)
## S4 method for signature 'fciAlgo,ANY'
plot(x, y, main = NULL, ...)

Arguments

`x, object`	a `"fciAlgo"` object.
`amat`	`logical` indicating if the adjacency matrix should be shown (printed) as well.
`zero.print`	string for printing `0` (‘zero’) entries in the adjacency matrix.
`y`	(generic `plot()` argument; unused).
`main`	main title, not yet supported.

...

optional further arguments (passed from and to methods).

Slots

The slots call, n, max.ord, n.edgetests, sepset, and pMax are inherited from class "gAlgo", see there.

In addition, "fciAlgo" has slots

amat:: adjacency matrix; for the coding of the adjacency matrix see amatType
allPdsep: a list: the ith entry of this list contains Possible D-SEP of node number i.
n.edgetestsPDSEP: the number of new conditional independence tests (i.e., tests that were not done in the first part of the algorithm) that were performed while checking subsets of Possible D-SEP.
max.ordPDSEP: an integer: the maximum size of the conditioning sets used in the new conditional independence that were performed when checking subsets of Possible D-SEP.

Extends

Class "gAlgo".

Methods

plot: signature(x = "fciAlgo"): Plot the resulting graph
show: signature(object = "fciAlgo"): Show basic properties of the fitted object
summary: signature(object = "fciAlgo"): Show details of the fitted object

Author(s)

Markus Kalisch and Martin Maechler

Examples

## look at slots of the class
showClass("fciAlgo")

## Also look at the extensive examples in ?fci , ?fciPlus, etc !

## Not run: 
## Suppose, fciObj is an object of class fciAlgo
## access slots by using the @ symbol
fciObj@amat   ## adjacency matrix
fciObj@sepset ## separation sets

## use show, summary and plot method
fciObj ## same as  show(fciObj)
show(fciObj)
summary(fciObj)
plot(fciObj)

## End(Not run)

pcalg

Methods for Graphical Models and Causal Inference

v2.7-2

GPL (>= 2)

Authors

Markus Kalisch [aut, cre], Alain Hauser [aut], Martin Maechler [aut], Diego Colombo [ctb], Doris Entner [ctb], Patrik Hoyer [ctb], Antti Hyttinen [ctb], Jonas Peters [ctb], Nicoletta Andri [ctb], Emilija Perkovic [ctb], Preetam Nandy [ctb], Philipp Ruetimann [ctb], Daniel Stekhoven [ctb], Manuel Schuerch [ctb], Marco Eigenmann [ctb], Leonard Henckel [ctb], Joris Mooij [ctb]

Initial release

2021-4-20