[gnumeric] add brief documentation of the normality tests tool
- From: Andreas J. Guelzow <guelzow src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnumeric] add brief documentation of the normality tests tool
- Date: Mon, 30 May 2011 17:57:51 +0000 (UTC)
commit 7925f55e4362707a23a6120c897c80583ce939c9
Author: Andreas J Guelzow <aguelzow pyrshep ca>
Date: Mon May 30 11:56:58 2011 -0600
add brief documentation of the normality tests tool
2011-05-30 Andreas J. Guelzow <aguelzow pyrshep ca>
* analysis-statistical.xml: add brief documentation of
the normality tests tool
* analysistools-normality-ex1.png: new
* analysistools-normality-ex2.png: new
* analysistools-normality-ex3.png: new
* analysistools-normality-ex4.png: new
* analysistools-normality-testspec.png: new
* analysistools-normality.png: new
* Makefile.am: add the above image files
2
NEWS | 1 +
doc/C/ChangeLog | 12 ++
doc/C/analysis-statistical.xml | 144 +++++++++++++++++++-
doc/C/figures/Makefile.am | 6 +
doc/C/figures/analysistools-normality-ex1.png | Bin 0 -> 27715 bytes
doc/C/figures/analysistools-normality-ex2.png | Bin 0 -> 30864 bytes
doc/C/figures/analysistools-normality-ex3.png | Bin 0 -> 30164 bytes
doc/C/figures/analysistools-normality-ex4.png | Bin 0 -> 23596 bytes
doc/C/figures/analysistools-normality-testspec.png | Bin 0 -> 30152 bytes
doc/C/figures/analysistools-normality.png | Bin 0 -> 27486 bytes
10 files changed, 161 insertions(+), 2 deletions(-)
---
diff --git a/NEWS b/NEWS
index 9a06985..efd9f1b 100644
--- a/NEWS
+++ b/NEWS
@@ -9,6 +9,7 @@ Andreas
* Change the default widget when rolling up or down the default widget.
[#651173][#646612]
* Import external references from ODF. [#645580]
+ * Some documentation improvements.
Morten:
* Fix leaks in SHEET. [#650761]
diff --git a/doc/C/ChangeLog b/doc/C/ChangeLog
index e3a0a2b..edbfbb7 100644
--- a/doc/C/ChangeLog
+++ b/doc/C/ChangeLog
@@ -1,3 +1,15 @@
+2011-05-30 Andreas J. Guelzow <aguelzow pyrshep ca>
+
+ * analysis-statistical.xml: add brief documentation of
+ the normality tests tool
+ * analysistools-normality-ex1.png: new
+ * analysistools-normality-ex2.png: new
+ * analysistools-normality-ex3.png: new
+ * analysistools-normality-ex4.png: new
+ * analysistools-normality-testspec.png: new
+ * analysistools-normality.png: new
+ * Makefile.am: add the above image files
+
2011-05-29 Andreas J. Guelzow <aguelzow pyrshep ca>
* analysis-statistical.xml: add brief documentation of
diff --git a/doc/C/analysis-statistical.xml b/doc/C/analysis-statistical.xml
index 70fdc7f..e49e4ce 100644
--- a/doc/C/analysis-statistical.xml
+++ b/doc/C/analysis-statistical.xml
@@ -2520,8 +2520,148 @@
<sect2 id="normality-tool">
<title>Normality Tests</title>
- <para></para>
- </sect2>
+<para>The normality test tool provides for four tests of normality.</para>
+<orderedlist>
+ <listitem><para>Anderson Darling Test</para></listitem>
+ <listitem><para>Cramér-von Mises Test</para></listitem>
+ <listitem><para>Lilliefors (Kolmogorov-Smirnov) Test</para></listitem>
+ <listitem><para>Shapiro-Francia Test</para></listitem>
+</orderedlist>
+ <figure id="normality-tool-dialog">
+ <title>Normality Test Dialog</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/analysistools-normality.png"
+ format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>An image of the normality test dialog.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>The data range is specified via the <quote><guilabel>Input
+ Range:</guilabel></quote> entry
+ (see <xref linkend="normality-tool-dialog" />). The given range
+ or list of ranges can be grouped into
+ separate data sets by columns, rows, or areas. The tool performs a
+ separate test for each data set.</para>
+ <figure id="normality-tool-testspec-dialog">
+ <title>Test Tab of the Normality Test Dialog</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/analysistools-normality-testspec.png"
+ format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>An image of the test tab of the normality
+ test dialog.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>On the test tab one specifies which of the four tests to
+ perform, the significance level for the test and whether to include
+ a normal probability plot of the data
+ (see <xref linkend="normality-tool-testspec-dialog" />).</para>
+ <figure id="normality-example-1">
+ <title>Normality Test Example Data</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/analysistools-normality-ex1.png"
+ format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>An image of example data for a normality test.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <example id="usingnormalitytesttool">
+ <title>Using the Normality Test Tool</title>
+
+ <para>
+ Suppose you want to perform a Lilliefors (Kolmogorov-Smirnov) Test
+ for Normality on the data
+ given in <xref linkend="normality-example-1" />.</para>
+<orderedlist>
+ <listitem><para>
+ Enter A1:A50 (or Sheet1!$A$1:$A$50) in the
+ <quote><guilabel>Input Range:</guilabel></quote>
+ entry by typing
+ this directly into the entry or clicking in the entry field and
+ then selecting the range on the sheet.</para></listitem>
+ <listitem><para> Select the <quote><guibutton>Labels</guibutton></quote>
+ option since the first row contains a label. (see
+ <xref linkend="normality-example-2" />).</para></listitem>
+ <listitem><para> On the test tab of the dialog
+ (see <xref linkend="normality-example-3" />) select the
+ Lilliefors (Kolmogorov-Smirnov) Test.</para></listitem>
+ <listitem><para> Specify an appropriate significance level
+ Alpha, say 0.05.</para></listitem>
+ <listitem><para> Select the <quote><guibutton>Create Normal
+ Probability Plot</guibutton></quote>
+ option to include a normal
+ probability plot in the output.</para></listitem>
+ <listitem><para> Specify the output
+ options as described above.</para></listitem>
+ <listitem><para> Press the OK button. </para></listitem>
+</orderedlist>
+ <para> The output of this normality test is shown in
+ <xref linkend="normality-example-4" />. Note that the graph appears
+ initially on top of the output data and needs to be moved to make
+ the data visible.</para>
+ </example>
+
+ <figure id="normality-example-2">
+ <title>Completed Input Tab of the Normality Test Dialog</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/analysistools-normality-ex2.png"
+ format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>An image of the completed input tab of the normality
+ test dialog.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <figure id="normality-example-3">
+ <title>Completed Test Tab of the Normality Test Dialog</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/analysistools-normality-ex3.png"
+ format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>An image of the completed test tab of the normality
+ test dialog.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <figure id="normality-example-4">
+ <title>Normality Test Output</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/analysistools-normality-ex4.png"
+ format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>An image of the output from a normality test.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </sect2>
<sect2 id="one-median-tool">
diff --git a/doc/C/figures/Makefile.am b/doc/C/figures/Makefile.am
index 642f8ed..e250b4c 100644
--- a/doc/C/figures/Makefile.am
+++ b/doc/C/figures/Makefile.am
@@ -62,6 +62,12 @@ EXTRA_DIST = \
analysistools-moving-average-formula-central.png \
analysistools-moving-average-formula-spencer.png \
analysistools-moving-average-formula-weighted.png \
+ analysistools-normality-ex1.png \
+ analysistools-normality-ex2.png \
+ analysistools-normality-ex3.png \
+ analysistools-normality-ex4.png \
+ analysistools-normality-testspec.png \
+ analysistools-normality.png \
analysistools-outputoptions.png \
analysistools-pcanalysis.png \
analysistools-pcanalysis-ex1.png \
diff --git a/doc/C/figures/analysistools-normality-ex1.png b/doc/C/figures/analysistools-normality-ex1.png
new file mode 100644
index 0000000..ab02c50
Binary files /dev/null and b/doc/C/figures/analysistools-normality-ex1.png differ
diff --git a/doc/C/figures/analysistools-normality-ex2.png b/doc/C/figures/analysistools-normality-ex2.png
new file mode 100644
index 0000000..cf84921
Binary files /dev/null and b/doc/C/figures/analysistools-normality-ex2.png differ
diff --git a/doc/C/figures/analysistools-normality-ex3.png b/doc/C/figures/analysistools-normality-ex3.png
new file mode 100644
index 0000000..dcf7950
Binary files /dev/null and b/doc/C/figures/analysistools-normality-ex3.png differ
diff --git a/doc/C/figures/analysistools-normality-ex4.png b/doc/C/figures/analysistools-normality-ex4.png
new file mode 100644
index 0000000..78150c9
Binary files /dev/null and b/doc/C/figures/analysistools-normality-ex4.png differ
diff --git a/doc/C/figures/analysistools-normality-testspec.png b/doc/C/figures/analysistools-normality-testspec.png
new file mode 100644
index 0000000..6590597
Binary files /dev/null and b/doc/C/figures/analysistools-normality-testspec.png differ
diff --git a/doc/C/figures/analysistools-normality.png b/doc/C/figures/analysistools-normality.png
new file mode 100644
index 0000000..1ff4f6f
Binary files /dev/null and b/doc/C/figures/analysistools-normality.png differ
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
