octave_packages/m/statistics/tests/t_test.m

   1 ## Copyright (C) 1995-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{t}, @var{df}] =} t_test (@var{x}, @var{m}, @var{alt})
  21 ## For a sample @var{x} from a normal distribution with unknown mean and
  22 ## variance, perform a t-test of the null hypothesis @code{mean
  23 ## (@var{x}) == @var{m}}.  Under the null, the test statistic @var{t}
  24 ## follows a Student distribution with @code{@var{df} = length (@var{x})
  25 ## - 1} degrees of freedom.
  26 ##
  27 ## With the optional argument string @var{alt}, the alternative of
  28 ## interest can be selected.  If @var{alt} is @code{"!="} or
  29 ## @code{"<>"}, the null is tested against the two-sided alternative
  30 ## @code{mean (@var{x}) != @var{m}}.  If @var{alt} is @code{">"}, the
  31 ## one-sided alternative @code{mean (@var{x}) > @var{m}} is considered.
  32 ## Similarly for @var{"<"}, the one-sided alternative @code{mean
  33 ## (@var{x}) < @var{m}} is considered.  The default is the two-sided
  34 ## case.
  35 ##
  36 ## The p-value of the test is returned in @var{pval}.
  37 ##
  38 ## If no output argument is given, the p-value of the test is displayed.
  39 ## @end deftypefn
  40
  41 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  42 ## Description: Student's one-sample t test
  43
  44 function [pval, t, df] = t_test (x, m, alt)
  45
  46   if ((nargin < 2) || (nargin > 3))
  47     print_usage ();
  48   endif
  49
  50   if (! isvector (x))
  51     error ("t_test: X must be a vector");
  52   endif
  53   if (! isscalar (m))
  54     error ("t_test: M must be a scalar");
  55   endif
  56
  57   n   = length (x);
  58   df  = n - 1;
  59   t   = sqrt (n) * (sum (x) / n - m) / std (x);
  60   cdf = tcdf (t, df);
  61
  62   if (nargin == 2)
  63     alt  = "!=";
  64   endif
  65
  66   if (! ischar (alt))
  67     error ("t_test: ALT must be a string");
  68   endif
  69   if (strcmp (alt, "!=") || strcmp (alt, "<>"))
  70     pval = 2 * min (cdf, 1 - cdf);
  71   elseif strcmp (alt, ">")
  72     pval = 1 - cdf;
  73   elseif strcmp (alt, "<")
  74     pval = cdf;
  75   else
  76     error ("t_test: option %s not recognized", alt);
  77   endif
  78
  79   if (nargout == 0)
  80     printf ("  pval: %g\n", pval);
  81   endif
  82
  83 endfunction