Package edu.cmu.tetrad.algcomparison.independence

Class FisherZ

java.lang.Object

edu.cmu.tetrad.algcomparison.independence.FisherZ

All Implemented Interfaces:

IndependenceWrapper, HasParameters, TetradSerializable, Serializable

@TestOfIndependence(name="Fisher Z Test",
                    command="fisher-z-test",
                    dataType={Continuous,Covariance})
@LinearGaussian
public class FisherZ
extends Object
implements IndependenceWrapper

Wrapper for Fisher Z test.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FisherZ()

Method Summary

Modifier and Type	Method	Description
DataType	getDataType()	Retrieves the data type that the search requires.
String	getDescription()	Retrieves the description of the Fisher Z Test.
List<String>	getParameters()	Retrieves the list of parameters required for the Fisher Z Test.
IndependenceTest	getTest(DataModel dataModel, Parameters parameters)	Retrieves an IndependenceTest object based on the given data model and parameters.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FisherZ

public FisherZ()

Method Details

getTest

public IndependenceTest getTest(DataModel dataModel,
 Parameters parameters)

Retrieves an IndependenceTest object based on the given data model and parameters.

Specified by:

getTest in interface IndependenceWrapper

Parameters:

dataModel - The data set to test independence against.

parameters - The parameters of the test.

Returns:

An IndependenceTest object representing the test.

Throws:

IllegalArgumentException - If the data model is not a dataset or a covariance matrix.

getDescription

public String getDescription()

Retrieves the description of the Fisher Z Test.

Specified by:

getDescription in interface IndependenceWrapper

Returns:

The description of the Fisher Z Test.

getDataType

public DataType getDataType()

Retrieves the data type that the search requires.

Specified by:

getDataType in interface IndependenceWrapper

Returns:

The data type required by the search.

getParameters

public List<String> getParameters()

Retrieves the list of parameters required for the Fisher Z Test.

Specified by:

getParameters in interface HasParameters

Specified by:

getParameters in interface IndependenceWrapper

Returns:

A list of strings representing the parameters required for the Fisher Z Test.