diff scripts/statistics/tests/chisquare_test_independence.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/chisquare_test_independence.m
+++ b/scripts/statistics/tests/chisquare_test_independence.m
@@ -14,16 +14,18 @@
 ## along with this file.  If not, write to the Free Software Foundation,
 ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
-## usage:  [pval, chisq, df] = chisquare_test_independence (X)
-##
+## -*- texinfo -*-
+## @deftypefn {Function File} {[@var{pval}, @var{chisq}, @var{df}] =} chisquare_test_independence (@var{x})
 ## Perform a chi-square test for indepence based on the contingency
-## table X.
+## table @var{x}.  Under the null hypothesis of independence,
+## @var{chisq} approximately has a chi-square distribution with
+## @var{df} degrees of freedom.
 ##
-## Under the null hypothesis of independence, chisq approximately has a
-## chi-square distribution with df degrees of freedom. pval is the
-## p-value (1 minus the CDF of this distribution at chisq) of the test.
+## The p-value (1 minus the CDF of this distribution at chisq) of the
+## test is returned in @var{pval}.
 ##
 ## If no output argument is given, the p-value is displayed.
+## @end deftypefn
 
 ## Author:  KH <Kurt.Hornik@ci.tuwien.ac.at>
 ## Description:  Chi-square test for independence