sbrt.ext.R.stat
Class RCorrelator.Result

java.lang.Object
  extended by sbrt.ext.R.stat.RCorrelator.Result
All Implemented Interfaces:
CorrResult
Enclosing class:
RCorrelator<V>

public static final class RCorrelator.Result
extends java.lang.Object
implements CorrResult

This class is used to store the results of computing a correlation using R.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Method Summary
 double getCoeff()
          Returns the computed correlation coefficient.
 double getP()
          Returns the corresponding P value.
 double getStatistic()
          Returns the corresponding statistic.
 java.lang.String toString()
          Returns a string representation of this result.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getStatistic

public double getStatistic()
Returns the corresponding statistic.

Returns:
the corresponding statistic.

getCoeff

public double getCoeff()
Returns the computed correlation coefficient.

Specified by:
getCoeff in interface CorrResult
Returns:
the computed correlation coefficient.

getP

public double getP()
Returns the corresponding P value.

Returns:
the corresponding P value.

toString

public java.lang.String toString()
Returns a string representation of this result.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of this result.