StephenAshley.Biostatistics.FriedmanGroupsCollection Class Reference
A list of Group objects and the methods necessary for performing Friedman’s Test. More...
Public Member Functions | |
| FriedmanGroupsCollection () | |
| Constructs an empty FriedmanGroupsCollection. | |
| FriedmanGroupsCollection (List< Group > groups) | |
| Constructs a FriedmanGroupsCollection from a list of Group objects. | |
| override void | Add (Group group) |
| Adds a Group to the FriedmanGroupsCollection. | |
| Int32 | DegreesOfFreedom () |
| The degrees of freedom of the FriedmanGroupsCollection. | |
| NUMBER | FriedmanStatistic () |
| Returns the Friedman statistic (χ²r). | |
| NUMBER | CriticalValue () |
| Returns a value for p for the FriedmanGroupsCollection. | |
| Int32 | N () |
| Returns the number of subjects in the FriedmanGroupsCollection. | |
| NUMBER | p () |
| Returns the statistic p for the FriedmanGroupsCollection based on the χ² distribution. | |
| NUMBER[] | SumsOfRanks () |
| Returns an array containing the sums of the ranks for each treatment. | |
Detailed Description
A list of Group objects and the methods necessary for performing Friedman’s Test.See generally Stanton A. Glantz, Primer of Biostatistics ch. 10 (6th ed. 2005); Jerrold H. Zar, Biostatistical Analysis ch. 12 (5th ed. 2010 [sic])
Definition at line 18 of file FriedmanGroupsCollection.cs.
Constructor & Destructor Documentation
| StephenAshley.Biostatistics.FriedmanGroupsCollection.FriedmanGroupsCollection | ( | ) |
Constructs an empty FriedmanGroupsCollection.
Definition at line 23 of file FriedmanGroupsCollection.cs.
| StephenAshley.Biostatistics.FriedmanGroupsCollection.FriedmanGroupsCollection | ( | List< Group > | groups | ) |
Constructs a FriedmanGroupsCollection from a list of Group objects.
- Parameters:
-
groups The Group objects.
Definition at line 30 of file FriedmanGroupsCollection.cs.
Member Function Documentation
| override void StephenAshley.Biostatistics.FriedmanGroupsCollection.Add | ( | Group | group | ) | [virtual] |
Adds a Group to the FriedmanGroupsCollection.
- Parameters:
-
group The Group.
- Exceptions:
-
BiostatisticsException • the Group is a null reference, • the Group has no members, or
• the size of the Group is different from the sizes of the other Group objects.
Reimplemented from StephenAshley.Biostatistics.GroupsCollection.
Definition at line 41 of file FriedmanGroupsCollection.cs.
| NUMBER StephenAshley.Biostatistics.FriedmanGroupsCollection.CriticalValue | ( | ) |
Returns a value for p for the FriedmanGroupsCollection.
p is calculated from a table of critical values based on Jerrold H. Zar, Biostatistical Analysis Table B.14 (5th ed. 2010 [sic]). If this method returns a critical value of p, use that value to evaluate the treatments. If the FriedmanGroupsCollection is outside the range of the table of critical values and an exception is thrown, use p based on the χ² distribution.
- Returns:
- p.
- Exceptions:
-
BiostatisticsException the FriedmanGroupsCollection contains fewer than 2 subjects. the FriedmanGroupsCollection contains fewer than 2 treatments.
GroupsCollection.k is outside the range of the critical values table.
N is outside the range of the critical values table.
Definition at line 138 of file FriedmanGroupsCollection.cs.
| Int32 StephenAshley.Biostatistics.FriedmanGroupsCollection.DegreesOfFreedom | ( | ) |
The degrees of freedom of the FriedmanGroupsCollection.
- Returns:
- The degrees of freedom.
- Exceptions:
-
BiostatisticsException The FriedmanGroupsCollection contains no Group objects.
Definition at line 72 of file FriedmanGroupsCollection.cs.
| NUMBER StephenAshley.Biostatistics.FriedmanGroupsCollection.FriedmanStatistic | ( | ) |
Returns the Friedman statistic (χ²r).
- Returns:
- The statistic
- Exceptions:
-
BiostatisticsException The FriedmanGroupsCollection has fewer than 2 subjects, The FriedmanGroupsCollection has fewer than 2 treatments.
Definition at line 92 of file FriedmanGroupsCollection.cs.
| Int32 StephenAshley.Biostatistics.FriedmanGroupsCollection.N | ( | ) |
Returns the number of subjects in the FriedmanGroupsCollection.
- Returns:
- The number.
Definition at line 180 of file FriedmanGroupsCollection.cs.
| NUMBER StephenAshley.Biostatistics.FriedmanGroupsCollection.p | ( | ) |
Returns the statistic p for the FriedmanGroupsCollection based on the χ² distribution.
If CriticalValue returns a value for p, use that value rather than the value returned by p, as the χ² distribution is not an accurate approximation for small values of N.
- Returns:
- p.
Definition at line 196 of file FriedmanGroupsCollection.cs.
| NUMBER [] StephenAshley.Biostatistics.FriedmanGroupsCollection.SumsOfRanks | ( | ) |
Returns an array containing the sums of the ranks for each treatment.
- Returns:
- The array.
- Exceptions:
-
BiostatisticsException The FriedmanGroupsCollection contains no Group objects.
Definition at line 209 of file FriedmanGroupsCollection.cs.
The documentation for this class was generated from the following file:
- C:/Documents and Settings/Stephen/Desktop/Biostatistics Library and Program/Biostatistics/FriedmanGroupsCollection.cs
