octave_packages/m/statistics/base/ppplot.m

   1 ## Copyright (C) 1995-2012 Kurt Hornik
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {[@var{p}, @var{y}] =} ppplot (@var{x}, @var{dist}, @var{params})
  21 ## Perform a PP-plot (probability plot).
  22 ##
  23 ## If F is the CDF of the distribution @var{dist} with parameters
  24 ## @var{params} and @var{x} a sample vector of length @var{n}, the
  25 ## PP-plot graphs ordinate @var{y}(@var{i}) = F (@var{i}-th largest
  26 ## element of @var{x}) versus abscissa @var{p}(@var{i}) = (@var{i} -
  27 ## 0.5)/@var{n}.  If the sample comes from F, the pairs will
  28 ## approximately follow a straight line.
  29 ##
  30 ## The default for @var{dist} is the standard normal distribution.  The
  31 ## optional argument @var{params} contains a list of parameters of
  32 ## @var{dist}.  For example, for a probability plot of the uniform
  33 ## distribution on [2,4] and @var{x}, use
  34 ##
  35 ## @example
  36 ## ppplot (x, "uniform", 2, 4)
  37 ## @end example
  38 ##
  39 ## @noindent
  40 ## @var{dist} can be any string for which a function @var{dist_cdf}
  41 ## that calculates the CDF of distribution @var{dist} exists.
  42 ##
  43 ## If no output arguments are given, the data are plotted directly.
  44 ## @end deftypefn
  45
  46 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  47 ## Description: Perform a PP-plot (probability plot)
  48
  49 function [p, y] = ppplot (x, dist, varargin)
  50
  51   if (nargin < 1)
  52     print_usage ();
  53   endif
  54
  55   if (! isvector (x))
  56     error ("ppplot: X must be a vector");
  57   endif
  58
  59   s = sort (x);
  60   n = length (x);
  61   p = ((1 : n)' - 0.5) / n;
  62   if (nargin == 1)
  63     F = @stdnormal_cdf;
  64   else
  65     F = str2func (sprintf ("%scdf", dist));
  66   endif;
  67   if (nargin <= 2)
  68     y = feval (F, s);
  69   else
  70     y = feval (F, s, varargin{:});
  71   endif
  72
  73   if (nargout == 0)
  74     plot (p, y);
  75     axis ([0, 1, 0, 1]);
  76   endif
  77
  78 endfunction
  79
  80
  81 %% Test input validation
  82 %!error ppplot ();
  83 %!error ppplot (ones(2,2));
  84