StephenAshley.Biostatistics.OddsRatioTest Class Reference

Data and methods for the performance of the Odds Ratio Test. More...

List of all members.

Classes

struct  Fields

Public Member Functions

 OddsRatioTest ()
 Default constructor for an OddsRatioTest object.
 OddsRatioTest (Int32 a, Int32 b, Int32 c, Int32 d)
 Constructor for an OddsRatioTest object.
Int32 A ()
 Returns the value of the A cell of the contingency table.
void SetA (Int32 value)
 Sets the value of the A cell of the contingency table.
Int32 B ()
 Returns and sets the value of the C cell of the contingency table.
void SetB (Int32 value)
 Sets the value of the B cell of the contingency table.
Int32 C ()
 Returns and sets the value of the B cell of the contingency table.
void SetC (Int32 value)
 Sets the value of the C cell of the contingency table.
Int32 D ()
 Returns the value of the D cell of the contingency table.
void SetD (Int32 value)
 Sets the value of the D cell of the contingency table.
NUMBER ChiSquared ()
 Returns the value of Chi-Squared (χ²).
NUMBER ConfidenceIntervalUpperLimit ()
 Returns the upper limit of the 95% confidence interval.
NUMBER ConfidenceIntervalLowerLimit ()
 Returns the lower limit of the 95% confidence interval.
NUMBER LogOddsRatio ()
 Returns the log of the odds ratio.
NUMBER OddsRatio ()
 Returns the odds ratio.
NUMBER P ()
 Returns the probability p associated with the values in the OddsRatioTest contingency table.
NUMBER StandardErrorOfLogOddsRatio ()
 Returns the standard error of the log of the OddsRatio.


Detailed Description

Data and methods for the performance of the Odds Ratio Test.

See generally Stanton A. Glantz, Primer of Biostatistics ch. 5 (6th ed. 2005).

Definition at line 13 of file OddsRatioTest.cs.


Constructor & Destructor Documentation

StephenAshley.Biostatistics.OddsRatioTest.OddsRatioTest (  ) 

Default constructor for an OddsRatioTest object.

Definition at line 19 of file OddsRatioTest.cs.

StephenAshley.Biostatistics.OddsRatioTest.OddsRatioTest ( Int32  a,
Int32  b,
Int32  c,
Int32  d 
)

Constructor for an OddsRatioTest object.

Parameters:
a The value of the A cell.
b The value of the B cell.
c The value of the C cell.
d The value of the D cell.

Definition at line 28 of file OddsRatioTest.cs.


Member Function Documentation

Int32 StephenAshley.Biostatistics.OddsRatioTest.A (  ) 

Returns the value of the A cell of the contingency table.

Returns:
A.
Exceptions:
BiostatisticsException the value is less than 1.

Definition at line 46 of file OddsRatioTest.cs.

Int32 StephenAshley.Biostatistics.OddsRatioTest.B (  ) 

Returns and sets the value of the C cell of the contingency table.

Returns:
C.
Exceptions:
BiostatisticsException the value is less than 1.

Definition at line 72 of file OddsRatioTest.cs.

Int32 StephenAshley.Biostatistics.OddsRatioTest.C (  ) 

Returns and sets the value of the B cell of the contingency table.

Returns:
B.
Exceptions:
BiostatisticsException the value is less than 1.

Definition at line 98 of file OddsRatioTest.cs.

NUMBER StephenAshley.Biostatistics.OddsRatioTest.ChiSquared (  ) 

Returns the value of Chi-Squared (χ²).

Returns:
Chi-Squared.
Exceptions:
BiostatisticsException calculation of of Chi-Squared throws another exception.
BiostatisticsException division by zero is attempted.

Definition at line 150 of file OddsRatioTest.cs.

NUMBER StephenAshley.Biostatistics.OddsRatioTest.ConfidenceIntervalLowerLimit (  ) 

Returns the lower limit of the 95% confidence interval.

Returns:
The limit.
Exceptions:
BiostatisticsException calculation of the lower limit throws another exception.

Definition at line 225 of file OddsRatioTest.cs.

NUMBER StephenAshley.Biostatistics.OddsRatioTest.ConfidenceIntervalUpperLimit (  ) 

Returns the upper limit of the 95% confidence interval.

Returns:
The limit.
Exceptions:
BiostatisticsException calculation of the upper limit throws another exception.

Definition at line 204 of file OddsRatioTest.cs.

Int32 StephenAshley.Biostatistics.OddsRatioTest.D (  ) 

Returns the value of the D cell of the contingency table.

Returns:
D.
Exceptions:
BiostatisticsException the value is less than 1.

Definition at line 123 of file OddsRatioTest.cs.

NUMBER StephenAshley.Biostatistics.OddsRatioTest.LogOddsRatio (  ) 

Returns the log of the odds ratio.

Returns:
The log.
Exceptions:
BiostatisticsException calculation of the log throws another exception.

Definition at line 246 of file OddsRatioTest.cs.

NUMBER StephenAshley.Biostatistics.OddsRatioTest.OddsRatio (  ) 

Returns the odds ratio.

Returns:
The odds ratio.
Exceptions:
BiostatisticsException division by zero is attempted.

Definition at line 266 of file OddsRatioTest.cs.

NUMBER StephenAshley.Biostatistics.OddsRatioTest.P (  ) 

Returns the probability p associated with the values in the OddsRatioTest contingency table.

Returns:
The probability p.
Exceptions:
BiostatisticsException calculation of p throws another exception (i.e., the System.OverflowException.

Definition at line 288 of file OddsRatioTest.cs.

void StephenAshley.Biostatistics.OddsRatioTest.SetA ( Int32  value  ) 

Sets the value of the A cell of the contingency table.

Parameters:
value The value.
Exceptions:
BiostatisticsException value is less than 1.

Definition at line 58 of file OddsRatioTest.cs.

void StephenAshley.Biostatistics.OddsRatioTest.SetB ( Int32  value  ) 

Sets the value of the B cell of the contingency table.

Parameters:
value The value.
Exceptions:
BiostatisticsException value is less than 1.

Definition at line 84 of file OddsRatioTest.cs.

void StephenAshley.Biostatistics.OddsRatioTest.SetC ( Int32  value  ) 

Sets the value of the C cell of the contingency table.

Parameters:
value The value.
Exceptions:
BiostatisticsException value is less than 1.

Definition at line 110 of file OddsRatioTest.cs.

void StephenAshley.Biostatistics.OddsRatioTest.SetD ( Int32  value  ) 

Sets the value of the D cell of the contingency table.

Parameters:
value The value.
Exceptions:
BiostatisticsException value is less than 1.

Definition at line 135 of file OddsRatioTest.cs.

NUMBER StephenAshley.Biostatistics.OddsRatioTest.StandardErrorOfLogOddsRatio (  ) 

Returns the standard error of the log of the OddsRatio.

Returns:
The standard error.
Exceptions:
BiostatisticsException division by zero is attempted.

Definition at line 309 of file OddsRatioTest.cs.


The documentation for this class was generated from the following file:

Generated on Sun May 31 19:43:40 2009 for "Biostatistics Documentation" by  doxygen 1.5.9