readme.txt 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. CircStat for Matlab
  2. =======================
  3. Toolbox for circular statistics with Matlab.
  4. Authors: Philipp Berens & Marc J. Velasco
  5. Email: berens@tuebingen.mpg.de
  6. Homepage: http://www.kyb.tuebingen.mpg.de/~berens/circStat.html
  7. Contributors:
  8. Tal Krasovsky
  9. Reference:
  10. P. Berens, CircStat: A Matlab Toolbox for Circular Statistics, Journal of Statistical Software, Volume 31, Issue 10, 2009
  11. http://www.jstatsoft.org/v31/i10
  12. Please cite this paper when the provided code is used. See licensing terms for details.
  13. Contents:
  14. circ_r Resultant vector length
  15. circ_mean Mean direction of a sample of circular data
  16. circ_axial Mean direction for axial data
  17. circ_median Median direction of a sample of circular data
  18. circ_std Dispersion around the mean direction (std, mardia)
  19. circ_var Circular variance
  20. circ_skewness Circular skewness
  21. circ_kurtosis Circular kurtosis
  22. circ_moment Circular p-th moment
  23. circ_dist Distances around a circle
  24. circ_dist2 Pairwise distances around a circle
  25. circ_confmean Confidence intervals for mean direction
  26. circ_stats Summary statistics
  27. circ_rtest Rayleigh's test for nonuniformity
  28. circ_otest Hodges-Ajne test (omnibus test) for nonuniformity
  29. circ_raotest Rao's spacing test for nonuniformity
  30. circ_vtest V-Test for nonuniformity with known mean direction
  31. circ_medtest Test for median angle
  32. circ_mtest One-sample test for specified mean direction
  33. circ_wwtest Multi-sample test for equal means, one-factor ANOVA
  34. circ_hktest Two-factor ANOVA
  35. circ_ktest Test for equal concentration parameter
  36. circ_symtest Test for symmetry around median angle
  37. circ_kuipertest Test whether two distributions are identical (like KS test)
  38. circ_corrcc Circular-circular correlation coefficient
  39. circ_corrcl Circular-linear correlation coefficient
  40. circ_kappa Compute concentration parameter of a vm distribution
  41. circ_plot Visualization for circular data
  42. circ_clust Simple clustering for circular data
  43. circ_samplecdf Evaluate CDF of a sample of angles
  44. rad2ang Convert radian to angular values
  45. ang2rad Convert angular to radian values
  46. All functions take arguments in radians (expect for ang2rad). For a detailed description of arguments and outputs consult the help text in the files.
  47. Since 2010, most functions for descriptive statistics can be used in Matlab style matrix computations. As a last argument, add the dimension along which you want to average. This changes the behavior slightly from previous relaeses, in that input is not reshaped anymore into vector format. Per default, all computations are performed columnwise (along dimension 1). If you prefer to use the old functions, for now they are contained in the subdirectory 'old'.
  48. References:
  49. - E. Batschelet, Circular Statistics in Biology, Academic Press, 1981
  50. - N.I. Fisher, Statistical analysis of circular data, Cambridge University Press, 1996
  51. - S.R. Jammalamadaka et al., Topics in circular statistics, World Scientific, 2001
  52. - J.H. Zar, Biostatistical Analysis, Prentice Hall, 1999
  53. The implementation follows in most cases 'Biostatistical Analysis' and all referenced equations and tables are taken from this book, if not otherwise noted. In some cases, the other books were preferred for implementation was more straightforward for solutions presented there.
  54. If you have suggestions, bugs or feature requests or want to contribute code, please email us.
  55. Disclaimer:
  56. All functions in this toolbox were implemented with care and tested on the examples presented in 'Biostatistical Analysis' were possible. Nevertheless, they may contain errors or bugs, which may affect the outcome of your analysis. We do not take responsibility for any harm coming from using this toolbox, neither if it is caused by errors in the software nor if it is caused by its improper application. Please email us any bugs you find.
  57. By Philipp Berens and Marc J. Velasco, 2009
  58. berens@tuebingen.mpg.de , velasco@ccs.fau.edu - www.kyb.mpg.de/~berens/circStat.html
  59. Distributed under Open Source BSD License