octave_packages/m/plot/pareto.m

   1 ## Copyright (C) 2007-2012 David Bateman
   2 ## Copyright (C) 2003 Alberto Terruzzi
   3 ##
   4 ## This file is part of Octave.
   5 ##
   6 ## Octave is free software; you can redistribute it and/or modify it
   7 ## under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 3 of the License, or (at
   9 ## your option) any later version.
  10 ##
  11 ## Octave is distributed in the hope that it will be useful, but
  12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 ## General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with Octave; see the file COPYING.  If not, see
  18 ## <http://www.gnu.org/licenses/>.
  19
  20 ## -*- texinfo -*-
  21 ## @deftypefn  {Function File} {} pareto (@var{x})
  22 ## @deftypefnx {Function File} {} pareto (@var{x}, @var{y})
  23 ## @deftypefnx {Function File} {} pareto (@var{h}, @dots{})
  24 ## @deftypefnx {Function File} {@var{h} =} pareto (@dots{})
  25 ## Draw a Pareto chart, also called ABC chart.  A Pareto chart is a bar graph
  26 ## used to arrange information in such a way that priorities for process
  27 ## improvement can be established.  It organizes and displays information
  28 ## to show the relative importance of data.  The chart is similar to the
  29 ## histogram or bar chart, except that the bars are arranged in decreasing
  30 ## order from left to right along the abscissa.
  31 ##
  32 ## The fundamental idea (Pareto principle) behind the use of Pareto
  33 ## diagrams is that the majority of an effect is due to a small subset of the
  34 ## causes, so for quality improvement the first few (as presented on the
  35 ## diagram) contributing causes to a problem usually account for the majority
  36 ## of the result.  Thus, targeting these "major causes" for elimination
  37 ## results in the most cost-effective improvement scheme.
  38 ##
  39 ## The data are passed as @var{x} and the abscissa as @var{y}.  If @var{y} is
  40 ## absent, then the abscissa are assumed to be @code{1 : length (@var{x})}.
  41 ## @var{y} can be a string array, a cell array of strings or a numerical
  42 ## vector.
  43 ##
  44 ## The optional return value @var{h} is a 2-element vector with a graphics
  45 ## handle for the created bar plot and a second handle for the created line
  46 ## plot.
  47 ##
  48 ## An example of the use of @code{pareto} is
  49 ##
  50 ## @example
  51 ## @group
  52 ## Cheese = @{"Cheddar", "Swiss", "Camembert", ...
  53 ##           "Munster", "Stilton", "Blue"@};
  54 ## Sold = [105, 30, 70, 10, 15, 20];
  55 ## pareto (Sold, Cheese);
  56 ## @end group
  57 ## @end example
  58 ## @end deftypefn
  59
  60 function h = pareto (varargin)
  61
  62   if (nargin != 1 && nargin != 2)
  63     print_usage ();
  64   endif
  65
  66   x = varargin {1}(:).';
  67   if (nargin == 2)
  68     y = varargin {2}(:).';
  69     if (! iscell (y))
  70       if (ischar (y))
  71         y = cellstr (y);
  72       else
  73         y = cellfun ("num2str", num2cell (y), "uniformoutput", false);
  74       endif
  75     endif
  76   else
  77     y = cellfun ("int2str", num2cell (1 : numel(x)),
  78                  "uniformoutput", false);
  79   endif
  80
  81   [x, idx] = sort (x, "descend");
  82   y = y (idx);
  83   cdf = cumsum (x);
  84   maxcdf = max(cdf);
  85   cdf = cdf ./ maxcdf;
  86   cdf95 = cdf - 0.95;
  87   idx95 = find(sign(cdf95(1:end-1)) != sign(cdf95(2:end)))(1);
  88
  89   [ax, hbar, hline] = plotyy (1 : idx95, x (1 : idx95),
  90                               1 : length(cdf), 100 .* cdf,
  91                               @bar, @plot);
  92
  93   axis (ax(1), [1 - 0.6, idx95 + 0.6, 0, maxcdf]);
  94   axis (ax(2), [1 - 0.6, idx95 + 0.6, 0, 100]);
  95   set (ax(2), "ytick", [0, 20, 40, 60, 80, 100],
  96        "yticklabel", {"0%", "20%", "40%", "60%", "80%", "100%"});
  97   set (ax(1), "xtick", 1 : idx95, "xticklabel", y (1: idx95));
  98   set (ax(2), "xtick", 1 : idx95, "xticklabel", y (1: idx95));
  99
 100   if (nargout > 0)
 101     h = [hbar; hline];
 102   endif
 103
 104 endfunction
 105
 106
 107 %!demo
 108 %! clf
 109 %! colormap (jet (64));
 110 %! Cheese = {"Cheddar", "Swiss", "Camembert", "Munster", "Stilton", "Blue"};
 111 %! Sold = [105, 30, 70, 10, 15, 20];
 112 %! pareto (Sold, Cheese);
 113
 114 %!demo
 115 %! clf
 116 %! % Suppose that we want establish which products makes 80 % of turnover.
 117 %! Codes = {"AB4","BD7","CF8","CC5","AD11","BB5","BB3","AD8","DF3","DE7"};
 118 %! Value = [2.35 7.9 2.45 1.1 0.15 13.45 5.4 2.05 0.85  1.65]';
 119 %! SoldUnits = [54723 41114 16939 1576091 168000 687197 120222 168195, ...
 120 %!              1084118 55576]';
 121 %! pareto (Value.*SoldUnits, Codes);
 122