Mercurial > octave

comparison scripts/statistics/tests/cor_test.m @ 20174:d9341b422488 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed statistics/ and @ftp/ in scripts directory. * scripts/@ftp/ascii.m, scripts/@ftp/binary.m, scripts/@ftp/cd.m, scripts/@ftp/dir.m, scripts/@ftp/ftp.m, scripts/@ftp/mget.m, scripts/@ftp/mput.m, scripts/statistics/base/center.m, scripts/statistics/base/cloglog.m, scripts/statistics/base/cov.m, scripts/statistics/base/gls.m, scripts/statistics/base/histc.m, scripts/statistics/base/iqr.m, scripts/statistics/base/kendall.m, scripts/statistics/base/kurtosis.m, scripts/statistics/base/logit.m, scripts/statistics/base/lscov.m, scripts/statistics/base/mahalanobis.m, scripts/statistics/base/mean.m, scripts/statistics/base/meansq.m, scripts/statistics/base/median.m, scripts/statistics/base/mode.m, scripts/statistics/base/moment.m, scripts/statistics/base/ols.m, scripts/statistics/base/ppplot.m, scripts/statistics/base/prctile.m, scripts/statistics/base/probit.m, scripts/statistics/base/range.m, scripts/statistics/base/ranks.m, scripts/statistics/base/run_count.m, scripts/statistics/base/runlength.m, scripts/statistics/base/skewness.m, scripts/statistics/base/spearman.m, scripts/statistics/base/statistics.m, scripts/statistics/base/std.m, scripts/statistics/base/table.m, scripts/statistics/base/var.m, scripts/statistics/base/zscore.m, scripts/statistics/distributions/betainv.m, scripts/statistics/distributions/binoinv.m, scripts/statistics/distributions/binopdf.m, scripts/statistics/distributions/cauchy_cdf.m, scripts/statistics/distributions/cauchy_inv.m, scripts/statistics/distributions/cauchy_pdf.m, scripts/statistics/distributions/chi2cdf.m, scripts/statistics/distributions/chi2inv.m, scripts/statistics/distributions/chi2pdf.m, scripts/statistics/distributions/discrete_cdf.m, scripts/statistics/distributions/discrete_inv.m, scripts/statistics/distributions/discrete_pdf.m, scripts/statistics/distributions/empirical_cdf.m, scripts/statistics/distributions/empirical_inv.m, scripts/statistics/distributions/empirical_pdf.m, scripts/statistics/distributions/expcdf.m, scripts/statistics/distributions/expinv.m, scripts/statistics/distributions/exppdf.m, scripts/statistics/distributions/finv.m, scripts/statistics/distributions/fpdf.m, scripts/statistics/distributions/gamcdf.m, scripts/statistics/distributions/gaminv.m, scripts/statistics/distributions/gampdf.m, scripts/statistics/distributions/geoinv.m, scripts/statistics/distributions/geopdf.m, scripts/statistics/distributions/hygecdf.m, scripts/statistics/distributions/hygeinv.m, scripts/statistics/distributions/hygepdf.m, scripts/statistics/distributions/kolmogorov_smirnov_cdf.m, scripts/statistics/distributions/laplace_cdf.m, scripts/statistics/distributions/laplace_inv.m, scripts/statistics/distributions/laplace_pdf.m, scripts/statistics/distributions/logistic_inv.m, scripts/statistics/distributions/logncdf.m, scripts/statistics/distributions/logninv.m, scripts/statistics/distributions/lognpdf.m, scripts/statistics/distributions/nbincdf.m, scripts/statistics/distributions/nbininv.m, scripts/statistics/distributions/nbinpdf.m, scripts/statistics/distributions/nbinrnd.m, scripts/statistics/distributions/normcdf.m, scripts/statistics/distributions/norminv.m, scripts/statistics/distributions/normpdf.m, scripts/statistics/distributions/poisscdf.m, scripts/statistics/distributions/poissinv.m, scripts/statistics/distributions/poisspdf.m, scripts/statistics/distributions/stdnormal_cdf.m, scripts/statistics/distributions/stdnormal_pdf.m, scripts/statistics/distributions/tcdf.m, scripts/statistics/distributions/tinv.m, scripts/statistics/distributions/tpdf.m, scripts/statistics/distributions/unidcdf.m, scripts/statistics/distributions/unidinv.m, scripts/statistics/distributions/unidpdf.m, scripts/statistics/distributions/unidrnd.m, scripts/statistics/distributions/unifcdf.m, scripts/statistics/distributions/unifinv.m, scripts/statistics/distributions/wblcdf.m, scripts/statistics/distributions/wblinv.m, scripts/statistics/distributions/wblpdf.m, scripts/statistics/distributions/wienrnd.m, scripts/statistics/models/private/logistic_regression_derivatives.m, scripts/statistics/models/private/logistic_regression_likelihood.m, scripts/statistics/tests/anova.m, scripts/statistics/tests/chisquare_test_homogeneity.m, scripts/statistics/tests/chisquare_test_independence.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/f_test_regression.m, scripts/statistics/tests/hotelling_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/run_test.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 10 May 2015 16:07:41 -0700
parents 9fc020886ae9
children d903cccb8de8
comparison
equal deleted inserted replaced
20173:777f26aa8e3e 20174:d9341b422488
20 ## @deftypefn {Function File} {} cor_test (@var{x}, @var{y}, @var{alt}, @var{method}) 20 ## @deftypefn {Function File} {} cor_test (@var{x}, @var{y}, @var{alt}, @var{method})
21 ## Test whether two samples @var{x} and @var{y} come from uncorrelated 21 ## Test whether two samples @var{x} and @var{y} come from uncorrelated
22 ## populations. 22 ## populations.
23 ## 23 ##
24 ## The optional argument string @var{alt} describes the alternative 24 ## The optional argument string @var{alt} describes the alternative
25 ## hypothesis, and can be @qcode{"!="} or @qcode{"<>"} (nonzero), 25 ## hypothesis, and can be @qcode{"!="} or @qcode{"<>"} (nonzero), @qcode{">"}
26 ## @qcode{">"} (greater than 0), or @qcode{"<"} (less than 0). The 26 ## (greater than 0), or @qcode{"<"} (less than 0). The default is the
27 ## default is the two-sided case. 27 ## two-sided case.
28 ## 28 ##
29 ## The optional argument string @var{method} specifies which 29 ## The optional argument string @var{method} specifies which correlation
30 ## correlation coefficient to use for testing. If @var{method} is 30 ## coefficient to use for testing. If @var{method} is @qcode{"pearson"}
31 ## @qcode{"pearson"} (default), the (usual) Pearson's product moment 31 ## (default), the (usual) Pearson's produt moment correlation coefficient is
32 ## correlation coefficient is used. In this case, the data should come 32 ## used. In this case, the data should come from a bivariate normal
33 ## from a bivariate normal distribution. Otherwise, the other two 33 ## distribution. Otherwise, the other two methods offer nonparametric
34 ## methods offer nonparametric alternatives. If @var{method} is 34 ## alternatives. If @var{method} is @qcode{"kendall"}, then Kendall's rank
35 ## @qcode{"kendall"}, then Kendall's rank correlation tau is used. If 35 ## correlation tau is used. If @var{method} is @qcode{"spearman"}, then
36 ## @var{method} is @qcode{"spearman"}, then Spearman's rank correlation 36 ## Spearman's rank correlation rho is used. Only the first character is
37 ## rho is used. Only the first character is necessary. 37 ## necessary.
38 ## 38 ##
39 ## The output is a structure with the following elements: 39 ## The output is a structure with the following elements:
40 ## 40 ##
41 ## @table @var 41 ## @table @var
42 ## @item pval 42 ## @item pval