octave_packages/m/statistics/tests/mcnemar_test.m

   1 ## Copyright (C) 1996-2012 Kurt Hornik
   2 ##
   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
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {[@var{pval}, @var{chisq}, @var{df}] =} mcnemar_test (@var{x})
  21 ## For a square contingency table @var{x} of data cross-classified on
  22 ## the row and column variables, McNemar's test can be used for testing
  23 ## the null hypothesis of symmetry of the classification probabilities.
  24 ##
  25 ## Under the null, @var{chisq} is approximately distributed as chisquare
  26 ## with @var{df} degrees of freedom.
  27 ##
  28 ## The p-value (1 minus the CDF of this distribution at @var{chisq}) is
  29 ## returned in @var{pval}.
  30 ##
  31 ## If no output argument is given, the p-value of the test is displayed.
  32 ## @end deftypefn
  33
  34 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  35 ## Description: McNemar's test for symmetry
  36
  37 function [pval, chisq, df] = mcnemar_test (x)
  38
  39   if (nargin != 1)
  40     print_usage ();
  41   endif
  42
  43   if (! (min (size (x)) > 1) && issquare (x))
  44     error ("mcnemar_test: X must be a square matrix of size > 1");
  45   elseif (! (all (all (x >= 0)) && all (all (x == fix (x)))))
  46     error ("mcnemar_test: all entries of X must be non-negative integers");
  47   endif
  48
  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
  56
  57   chisq = sum (sum (triu (num ./ (x + x'), 1)));
  58   pval = 1 - chi2cdf (chisq, df);
  59
  60   if (nargout == 0)
  61     printf ("  pval: %g\n", pval);
  62   endif
  63
  64 endfunction
  65
  66
  67