diff scripts/statistics/base/quantile.m @ 12569:6ef23b4a3402

Add quantile, prctile functions to documentation.
author Rik <octave@nomad.inbox5.com>
date Sat, 02 Apr 2011 13:37:52 -0700
parents 139f993936af
children 4e32a1bb9096 f96b9b9f141b
line wrap: on
line diff
--- a/scripts/statistics/base/quantile.m	Sat Apr 02 12:41:16 2011 -0700
+++ b/scripts/statistics/base/quantile.m	Sat Apr 02 13:37:52 2011 -0700
@@ -87,6 +87,16 @@
 ## @item R: A Language and Environment for Statistical Computing;
 ## @url{http://cran.r-project.org/doc/manuals/fullrefman.pdf}.
 ## @end itemize
+##
+## Examples:
+##
+## @example
+## @group
+## x = randi (1000, [10, 1]);  # Create random empirical data in range 1-1000
+## q = quantile (x, [0, 1]);   # Return minimum, maximum of empirical distribution
+## q = quantile (x, [0.25 0.5 0.75]); # Return quartiles of empirical distribution
+## @end group
+## @end example
 ## @seealso{prctile}
 ## @end deftypefn