All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.experiment.PairedTTester

java.lang.Object
   |
   +----weka.experiment.PairedTTester

public class PairedTTester

extends Object

implements OptionHandler

Valid options from the command-line are:

-D num,num2...
The column numbers that uniquely specify a dataset. (default last)

-R num
The column number containing the run number. (default last)

-S num
The significance level for T-Tests. (default 0.05)

-R num,num2...
The column numbers that uniquely specify one result generator (eg: scheme name plus options). (default last)

Author:

Len Trigg (trigg@cs.waikato.ac.nz)

PairedTTester()

calculateStatistics(Instance, int, int, int)

Computes a paired t-test comparison for a specified dataset between two resultsets.

getDatasetKeyColumns()

Get the value of DatasetKeyColumns.

getInstances()

Get the value of Instances.

getNumDatasets()

Gets the number of datasets in the resultsets

getNumResultsets()

Gets the number of resultsets in the data.

getOptions()

Gets current settings of the PairedTTester.

getProduceLatex()

Get whether latex is output

getResultsetKeyColumns()

Get the value of ResultsetKeyColumns.

getResultsetName(int)

Gets a string descriptive of the specified resultset.

getRunColumn()

Get the value of RunColumn.

getShowStdDevs()

Returns true if standard deviations have been requested.

getSignificanceLevel()

Get the value of SignificanceLevel.

header(int)

Creates a "header" string describing the current resultsets.

listOptions()

Lists options understood by this object.

main(String[])

Test the class from the command line.

multiResultsetFull(int, int)

Creates a comparison table where a base resultset is compared to the other resultsets.

multiResultsetRanking(int)

multiResultsetSummary(int)

Carries out a comparison between all resultsets, counting the number of datsets where one resultset outperforms the other.

multiResultsetWins(int)

Carries out a comparison between all resultsets, counting the number of datsets where one resultset outperforms the other.

resultsetKey()

Creates a key that maps resultset numbers to their descriptions.

setDatasetKeyColumns(Range)

Set the value of DatasetKeyColumns.

setInstances(Instances)

Set the value of Instances.

setOptions(String[])

Parses a given list of options.

setProduceLatex(boolean)

Set whether latex is output

setResultsetKeyColumns(Range)

Set the value of ResultsetKeyColumns.

setRunColumn(int)

Set the value of RunColumn.

setShowStdDevs(boolean)

Set whether standard deviations are displayed or not.

setSignificanceLevel(double)

Set the value of SignificanceLevel.

 public PairedTTester()

 public void setProduceLatex(boolean l)

Set whether latex is output

Parameters:

l - true if tables are to be produced in Latex format

 public boolean getProduceLatex()

Get whether latex is output

Returns:

true if Latex is to be output

 public void setShowStdDevs(boolean s)

Set whether standard deviations are displayed or not.

Parameters:

s - true if standard deviations are to be displayed

 public boolean getShowStdDevs()

Returns true if standard deviations have been requested.

Returns:

true if standard deviations are to be displayed.

 public int getNumDatasets()

Gets the number of datasets in the resultsets

Returns:

the number of datasets in the resultsets

 public int getNumResultsets()

Gets the number of resultsets in the data.

Returns:

the number of resultsets in the data

 public String getResultsetName(int index)

Gets a string descriptive of the specified resultset.

Parameters:

index - the index of the resultset

Returns:

a descriptive string for the resultset

 public PairedStats calculateStatistics(Instance datasetSpecifier,
                                        int resultset1Index,
                                        int resultset2Index,
                                        int comparisonColumn) throws Exception

Computes a paired t-test comparison for a specified dataset between two resultsets.

Parameters:

datasetSpecifier - the dataset specifier

resultset1Index - the index of the first resultset

resultset2Index - the index of the second resultset

comparisonColumn - the column containing values to compare

Returns:

the results of the paired comparison

Throws: Exception

if an error occurs

 public String resultsetKey()

Creates a key that maps resultset numbers to their descriptions.

Returns:

a value of type 'String'

 public String header(int comparisonColumn)

Creates a "header" string describing the current resultsets.

Parameters:

comparisonColumn - a value of type 'int'

Returns:

a value of type 'String'

 public int[][] multiResultsetWins(int comparisonColumn) throws Exception

Carries out a comparison between all resultsets, counting the number of datsets where one resultset outperforms the other.

Parameters:

comparisonColumn - the index of the comparison column

Returns:

a 2d array where element [i][j] is the number of times resultset j performed significantly better than resultset i.

Throws: Exception

if an error occurs

 public String multiResultsetSummary(int comparisonColumn) throws Exception

Carries out a comparison between all resultsets, counting the number of datsets where one resultset outperforms the other. The results are summarized in a table.

Parameters:

comparisonColumn - the index of the comparison column

Returns:

the results in a string

Throws: Exception

if an error occurs

 public String multiResultsetRanking(int comparisonColumn) throws Exception

 public String multiResultsetFull(int baseResultset,
                                  int comparisonColumn) throws Exception

Creates a comparison table where a base resultset is compared to the other resultsets. Results are presented for every dataset.

Parameters:

baseResultset - the index of the base resultset

comparisonColumn - the index of the column to compare over

Returns:

the comparison table string

Throws: Exception

if an error occurs

 public Enumeration listOptions()

Lists options understood by this object.

Returns:

an enumeration of Options.

 public void setOptions(String options[]) throws Exception

Parses a given list of options. Valid options are:

-D num,num2...
The column numbers that uniquely specify a dataset. (default last)

-R num
The column number containing the run number. (default last)

-S num
The significance level for T-Tests. (default 0.05)

-R num,num2...
The column numbers that uniquely specify one result generator (eg: scheme name plus options). (default last)

-V
Show standard deviations

-L
Produce comparison tables in Latex table format

Parameters:

options - an array containing options to set.

Throws: Exception

if invalid options are given

 public String[] getOptions()

Gets current settings of the PairedTTester.

Returns:

an array of strings containing current options.

 public Range getResultsetKeyColumns()

Get the value of ResultsetKeyColumns.

Returns:

Value of ResultsetKeyColumns.

 public void setResultsetKeyColumns(Range newResultsetKeyColumns)

Set the value of ResultsetKeyColumns.

Parameters:

newResultsetKeyColumns - Value to assign to ResultsetKeyColumns.

 public double getSignificanceLevel()

Get the value of SignificanceLevel.

Returns:

Value of SignificanceLevel.

 public void setSignificanceLevel(double newSignificanceLevel)

Set the value of SignificanceLevel.

Parameters:

newSignificanceLevel - Value to assign to SignificanceLevel.

 public Range getDatasetKeyColumns()

Get the value of DatasetKeyColumns.

Returns:

Value of DatasetKeyColumns.

 public void setDatasetKeyColumns(Range newDatasetKeyColumns)

Set the value of DatasetKeyColumns.

Parameters:

newDatasetKeyColumns - Value to assign to DatasetKeyColumns.

 public int getRunColumn()

Get the value of RunColumn.

Returns:

Value of RunColumn.

 public void setRunColumn(int newRunColumn)

Set the value of RunColumn.

Parameters:

newRunColumn - Value to assign to RunColumn.

 public Instances getInstances()

Get the value of Instances.

Returns:

Value of Instances.

 public void setInstances(Instances newInstances)

Set the value of Instances.

Parameters:

newInstances - Value to assign to Instances.

 public static void main(String args[])

Test the class from the command line.

Parameters:

args - contains options for the instance ttests

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home