[doc] misc. fix & improvements
[scilab.git] / scilab / modules / statistics / help / en_US / 3_dispersion_widths / iqr.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2000 - INRIA - Carlos Klimann
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="iqr">
17     <refnamediv>
18         <refname>iqr</refname>
19         <refpurpose>interquartile range</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>q=iqr(x)
24             q=iqr(x,'r') (or, equivalently, q=iqr(x,1))
25             q=iqr(x,'c') (or, equivalently, q=iqr(x,2))
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>x</term>
33                 <listitem>
34                     <para>real or complex vector or matrix</para>
35                 </listitem>
36             </varlistentry>
37         </variablelist>
38     </refsection>
39     <refsection>
40         <title>Description</title>
41         <para>
42             This function computes  the interquartile range IQR= upper
43             quartile - lower  quartile of a  vector or a  matrix <literal> x </literal>.
44         </para>
45         <para>
46             For a vector  or  a matrix <literal>  x</literal>  , <literal>  q=iqr(x)</literal>
47             returns in the scalar <literal> q</literal> the interquartile range of
48             all the entries of <literal> x</literal>.
49         </para>
50         <para>
51             <literal> q=iqr(x,'r') </literal>   (or, equivalently,
52             <literal>q=iqr(x,1)</literal>) is  the  rowwise interquartile range.  It  returns in
53             each entry  of the row vector  <literal> q</literal> the interquartile
54             range of each column of <literal> x</literal>.
55         </para>
56         <para>
57             <literal> q=iqr(x,'c')  </literal> (or,  equivalently,
58             <literal>q=iqr(x,2)</literal>) is the columnwise  interquartile range. It returns in
59             each     entry of  the    column  vector  <literal>   q</literal> the
60             interquartile range of each row of <literal> x</literal>.
61         </para>
62     </refsection>
63     <refsection>
64         <title>Examples</title>
65         <programlisting role="example"><![CDATA[
66 x  = 1:10;
67
68 // Interquartile range of vector 1 to 10
69 // Q1 = 3 and Q3 = 8, so iqr = 5
70 iqr(x)
71    ]]></programlisting>
72     </refsection>
73     <refsection>
74         <title>Bibliography</title>
75         <para>
76             Wonacott, T.H.Wonacott, R.J.; Introductory Statistics, J.Wiley-Sons, 1990.
77         </para>
78     </refsection>
79 </refentry>