Mercurial > octave
annotate scripts/statistics/tests/mcnemar_test.m @ 21634:96518f623c91
Backed out changeset dcf8922b724b
| author | Mike Miller <mtmiller@octave.org> |
|---|---|
| date | Wed, 20 Apr 2016 11:06:03 -0700 |
| parents | dcf8922b724b |
| children | bac0d6f07a3e |
| rev | line source |
|---|---|
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19040
diff
changeset
|
1 ## Copyright (C) 1996-2015 Kurt Hornik |
| 3426 | 2 ## |
| 3922 | 3 ## This file is part of Octave. |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 3426 | 9 ## |
| 3922 | 10 ## Octave is distributed in the hope that it will be useful, but |
| 3200 | 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 3426 | 13 ## General Public License for more details. |
| 14 ## | |
| 3200 | 15 ## You should have received a copy of the GNU General Public License |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 3200 | 18 |
| 3454 | 19 ## -*- texinfo -*- |
|
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20174
diff
changeset
|
20 ## @deftypefn {} {[@var{pval}, @var{chisq}, @var{df}] =} mcnemar_test (@var{x}) |
|
20174
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
21 ## For a square contingency table @var{x} of data cross-classified on the row |
|
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
22 ## and column variables, @nospell{McNemar's} test can be used for testing the |
|
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
23 ## null hypothesis of symmetry of the classification probabilities. |
| 3200 | 24 ## |
|
20174
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
25 ## Under the null, @var{chisq} is approximately distributed as chisquare with |
|
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
26 ## @var{df} degrees of freedom. |
| 3200 | 27 ## |
| 3454 | 28 ## The p-value (1 minus the CDF of this distribution at @var{chisq}) is |
| 29 ## returned in @var{pval}. | |
| 3200 | 30 ## |
| 31 ## If no output argument is given, the p-value of the test is displayed. | |
| 3454 | 32 ## @end deftypefn |
| 3426 | 33 |
| 5428 | 34 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 3456 | 35 ## Description: McNemar's test for symmetry |
| 3426 | 36 |
| 3200 | 37 function [pval, chisq, df] = mcnemar_test (x) |
| 3426 | 38 |
| 3200 | 39 if (nargin != 1) |
| 6046 | 40 print_usage (); |
| 3200 | 41 endif |
| 3426 | 42 |
| 4030 | 43 if (! (min (size (x)) > 1) && issquare (x)) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10680
diff
changeset
|
44 error ("mcnemar_test: X must be a square matrix of size > 1"); |
|
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
45 elseif (! (all ((x(:) >= 0)) && all (x(:) == fix (x(:))))) |
|
14062
5b49cafe0599
Use non-negative, non-positive with hyphens in error messages.
Rik <octave@nomad.inbox5.com>
parents:
13279
diff
changeset
|
46 error ("mcnemar_test: all entries of X must be non-negative integers"); |
| 3200 | 47 endif |
| 3426 | 48 |
| 3200 | 49 r = rows (x); |
| 50 df = r * (r - 1) / 2; | |
| 51 if (r == 2) | |
| 52 num = max (abs (x - x') - 1, 0) .^ 2; | |
| 53 else | |
| 54 num = abs (x - x') .^ 2; | |
| 55 endif | |
| 3426 | 56 |
| 3200 | 57 chisq = sum (sum (triu (num ./ (x + x'), 1))); |
|
10680
e00de2d5263c
Replace calls to obsolete chisquare_cdf with chi2cdf.
Rik <octave@nomad.inbox5.com>
parents:
7017
diff
changeset
|
58 pval = 1 - chi2cdf (chisq, df); |
| 3426 | 59 |
| 3200 | 60 if (nargout == 0) |
|
21634
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
61 printf (" pval: %g\n", pval); |
| 3200 | 62 endif |
| 3426 | 63 |
| 3200 | 64 endfunction |
| 65 |