diff scripts/statistics/tests/welch_test.m @ 3454:d8b731d3f7a3

[project @ 2000-01-18 10:13:31 by jwe]
author jwe
date Tue, 18 Jan 2000 10:13:39 +0000
parents f8dde1807dee
children 434790acb067
line wrap: on
line diff
--- a/scripts/statistics/tests/welch_test.m	Tue Jan 18 08:32:15 2000 +0000
+++ b/scripts/statistics/tests/welch_test.m	Tue Jan 18 10:13:39 2000 +0000
@@ -14,25 +14,25 @@
 ## along with this file.  If not, write to the Free Software Foundation,
 ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
-## usage:  [pval, t, df] = welch_test (x, y [, alt])
-##
-## For two samples x and y from normal distributions with unknown means
-## and unknown and not necessarily equal variances, perform a Welch test
-## of the null hypothesis of equal means.
+## -*- texinfo -*-
+## @deftypefn {Function File} {[@var{pval}, @var{t}, @var{df}] =} welch_test (@var{x}, @var{y}, @var{alt})
+## For two samples @var{x} and @var{y} from normal distributions with
+## unknown means and unknown and not necessarily equal variances,
+## perform a Welch test of the null hypothesis of equal means.
 ## Under the null, the test statistic t approximately follows a Student
 ## distribution with df degrees of freedom.
 ##
-## With the optional argument string alt, the alternative of interest
-## can be selected.
-## If alt is "!=" or "<>", the null is tested against the two-sided
-## alternative mean(x) != m.
-## If alt is ">", the one-sided alternative mean(x) > m is considered,
-## similarly for "<".
-## The default is the two-sided case.
+## With the optional argument string @var{alt}, the alternative of
+## interest can be selected.  If @var{alt} is @code{"!="} or
+## @code{"<>"}, the null is tested against the two-sided alternative
+## @code{mean (@var{x}) != @var{m}}.  If @var{alt} is @code{">"}, the
+## one-sided alternative mean(x) > m is considered, similarly for
+## @code{"<"}.  The default is the two-sided case.
 ##
-## pval is the p-value of the test.
+## The p-value of the test is returned in @var{pval}.
 ##
 ## If no output argument is given, the p-value of the test is displayed.
+## @end deftypefn
 
 ## Author:  KH <Kurt.Hornik@ci.tuwien.ac.at>
 ## Description:  Welch two-sample t test