Change traverse signal to take GtkSheetCell instead of gint,gint
[pspp-builds.git] / src / language / stats / examine.q
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2004, 2008 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include <gsl/gsl_cdf.h>
20 #include <libpspp/message.h>
21 #include <math.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24
25 #include <math/sort.h>
26 #include <math/order-stats.h>
27 #include <math/percentiles.h>
28 #include <math/tukey-hinges.h>
29 #include <math/box-whisker.h>
30 #include <math/trimmed-mean.h>
31 #include <math/extrema.h>
32 #include <math/np.h>
33 #include <data/case.h>
34 #include <data/casegrouper.h>
35 #include <data/casereader.h>
36 #include <data/casewriter.h>
37 #include <data/case-ordering.h>
38 #include <data/dictionary.h>
39 #include <data/procedure.h>
40 #include <data/value-labels.h>
41 #include <data/variable.h>
42 #include <language/command.h>
43 #include <language/dictionary/split-file.h>
44 #include <language/lexer/lexer.h>
45 #include <libpspp/compiler.h>
46 #include <libpspp/hash.h>
47 #include <libpspp/message.h>
48 #include <libpspp/misc.h>
49 #include <libpspp/str.h>
50 #include <math/moments.h>
51 #include <output/charts/box-whisker.h>
52 #include <output/charts/cartesian.h>
53 #include <output/manager.h>
54 #include <output/table.h>
55
56 #include "minmax.h"
57 #include "xalloc.h"
58
59 #include "gettext.h"
60 #define _(msgid) gettext (msgid)
61 #define N_(msgid) msgid
62
63 /* (headers) */
64 #include <output/chart.h>
65 #include <output/charts/plot-hist.h>
66 #include <output/charts/plot-chart.h>
67 #include <math/histogram.h>
68
69 /* (specification)
70    "EXAMINE" (xmn_):
71    *^variables=custom;
72    +total=custom;
73    +nototal=custom;
74    missing=miss:pairwise/!listwise,
75    rep:report/!noreport,
76    incl:include/!exclude;
77    +compare=cmp:variables/!groups;
78    +percentiles=custom;
79    +id=var;
80    +plot[plt_]=stemleaf,boxplot,npplot,:spreadlevel(*d:n),histogram,all,none;
81    +cinterval=double;
82    +statistics[st_]=descriptives,:extreme(*d:n),all,none.
83 */
84
85 /* (declarations) */
86
87 /* (functions) */
88
89
90 static struct cmd_examine cmd;
91
92 static const struct variable **dependent_vars;
93 static size_t n_dependent_vars;
94
95 /* PERCENTILES */
96
97 static subc_list_double percentile_list;
98 static enum pc_alg percentile_algorithm;
99
100 struct factor_metrics
101 {
102   struct moments1 *moments;
103
104   struct percentile **ptl;
105   size_t n_ptiles;
106
107   struct statistic *tukey_hinges;
108   struct statistic *box_whisker;
109   struct statistic *trimmed_mean;
110   struct statistic *histogram;
111   struct order_stats *np;
112
113   /* Three quartiles indexing into PTL */
114   struct percentile **quartiles;
115
116   /* A reader sorted in ASCENDING order */
117   struct casereader *up_reader;
118
119   /* The minimum value of all the weights */
120   double cmin;
121
122   /* Sum of all weights, including those for missing values */
123   double n;
124
125   double mean;
126
127   double variance;
128
129   double skewness;
130
131   double kurtosis;
132
133   double se_mean;
134
135   struct extrema *minima;
136   struct extrema *maxima;
137 };
138
139 struct factor_result
140 {
141   struct ll ll;
142
143   union value *value[2];
144
145   /* An array of factor metrics, one for each variable */
146   struct factor_metrics *metrics;
147 };
148
149 struct xfactor
150 {
151   /* We need to make a list of this structure */
152   struct ll ll;
153
154   /* The independent variable */
155   const struct variable const* indep_var[2];
156
157   /* A list of results for this factor */
158   struct ll_list result_list ;
159 };
160
161
162 static void
163 factor_destroy (struct xfactor *fctr)
164 {
165   struct ll *ll = ll_head (&fctr->result_list);
166   while (ll != ll_null (&fctr->result_list))
167     {
168       int v;
169       struct factor_result *result =
170         ll_data (ll, struct factor_result, ll);
171
172       for (v = 0; v < n_dependent_vars; ++v)
173         {
174           int i;
175           moments1_destroy (result->metrics[v].moments);
176           extrema_destroy (result->metrics[v].minima);
177           extrema_destroy (result->metrics[v].maxima);
178           statistic_destroy (result->metrics[v].trimmed_mean);
179           statistic_destroy (result->metrics[v].tukey_hinges);
180           statistic_destroy (result->metrics[v].box_whisker);
181           statistic_destroy (result->metrics[v].histogram);
182           for (i = 0 ; i < result->metrics[v].n_ptiles; ++i)
183             statistic_destroy ((struct statistic *) result->metrics[v].ptl[i]);
184           free (result->metrics[v].ptl);
185           free (result->metrics[v].quartiles);
186           casereader_destroy (result->metrics[v].up_reader);
187         }
188
189       free (result->value[0]);
190       free (result->value[1]);
191       free (result->metrics);
192       ll = ll_next (ll);
193       free (result);
194     }
195 }
196
197 static struct xfactor level0_factor;
198 static struct ll_list factor_list = LL_INITIALIZER (factor_list);
199
200 /* Parse the clause specifying the factors */
201 static int examine_parse_independent_vars (struct lexer *lexer,
202                                            const struct dictionary *dict,
203                                            struct cmd_examine *cmd);
204
205 /* Output functions */
206 static void show_summary (const struct variable **dependent_var, int n_dep_var,
207                           const struct xfactor *f);
208
209
210 static void show_descriptives (const struct variable **dependent_var,
211                                int n_dep_var,
212                                const struct xfactor *f);
213
214
215 static void show_percentiles (const struct variable **dependent_var,
216                                int n_dep_var,
217                                const struct xfactor *f);
218
219
220 static void show_extremes (const struct variable **dependent_var,
221                            int n_dep_var,
222                            const struct xfactor *f);
223
224
225
226
227 /* Per Split function */
228 static void run_examine (struct cmd_examine *, struct casereader *,
229                          struct dataset *);
230
231 static void output_examine (void);
232
233
234 void factor_calc (const struct ccase *c, int case_no,
235                   double weight, bool case_missing);
236
237
238 /* Represent a factor as a string, so it can be
239    printed in a human readable fashion */
240 static void factor_to_string (const struct xfactor *fctr,
241                               const struct factor_result *result,
242                               struct string *str);
243
244 /* Represent a factor as a string, so it can be
245    printed in a human readable fashion,
246    but sacrificing some readablility for the sake of brevity */
247 static void
248 factor_to_string_concise (const struct xfactor *fctr,
249                           const struct factor_result *result,
250                           struct string *str
251                           );
252
253
254
255 /* Categories of missing values to exclude. */
256 static enum mv_class exclude_values;
257
258 int
259 cmd_examine (struct lexer *lexer, struct dataset *ds)
260 {
261   struct casegrouper *grouper;
262   struct casereader *group;
263   bool ok;
264
265   subc_list_double_create (&percentile_list);
266   percentile_algorithm = PC_HAVERAGE;
267
268   if ( !parse_examine (lexer, ds, &cmd, NULL) )
269     {
270       subc_list_double_destroy (&percentile_list);
271       return CMD_FAILURE;
272     }
273
274   /* If /MISSING=INCLUDE is set, then user missing values are ignored */
275   exclude_values = cmd.incl == XMN_INCLUDE ? MV_SYSTEM : MV_ANY;
276
277   if ( cmd.st_n == SYSMIS )
278     cmd.st_n = 5;
279
280   if ( ! cmd.sbc_cinterval)
281     cmd.n_cinterval[0] = 95.0;
282
283   /* If descriptives have been requested, make sure the
284      quartiles are calculated */
285   if ( cmd.a_statistics[XMN_ST_DESCRIPTIVES] )
286     {
287       subc_list_double_push (&percentile_list, 25);
288       subc_list_double_push (&percentile_list, 50);
289       subc_list_double_push (&percentile_list, 75);
290     }
291
292   grouper = casegrouper_create_splits (proc_open (ds), dataset_dict (ds));
293
294   while (casegrouper_get_next_group (grouper, &group))
295     {
296       struct casereader *reader =
297         casereader_create_arithmetic_sequence (group, 1, 1);
298
299       run_examine (&cmd, reader, ds);
300     }
301
302   ok = casegrouper_destroy (grouper);
303   ok = proc_commit (ds) && ok;
304
305   if ( dependent_vars )
306     free (dependent_vars);
307
308   subc_list_double_destroy (&percentile_list);
309
310   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
311 };
312
313
314 /* Plot the normal and detrended normal plots for RESULT.
315    Label the plots with LABEL */
316 static void
317 np_plot (struct np *np, const char *label)
318 {
319   double yfirst = 0, ylast = 0;
320
321   double x_lower;
322   double x_upper;
323   double slack;
324
325   /* Normal Plot */
326   struct chart *np_chart;
327
328   /* Detrended Normal Plot */
329   struct chart *dnp_chart;
330
331   /* The slope and intercept of the ideal normal probability line */
332   const double slope = 1.0 / np->stddev;
333   const double intercept = -np->mean / np->stddev;
334
335   if ( np->n < 1.0 )
336     {
337       msg (MW, _("Not creating plot because data set is empty."));
338       return ;
339     }
340
341   np_chart = chart_create ();
342   dnp_chart = chart_create ();
343
344   if ( !np_chart || ! dnp_chart )
345     return ;
346
347   chart_write_title (np_chart, _("Normal Q-Q Plot of %s"), label);
348   chart_write_xlabel (np_chart, _("Observed Value"));
349   chart_write_ylabel (np_chart, _("Expected Normal"));
350
351   chart_write_title (dnp_chart, _("Detrended Normal Q-Q Plot of %s"),
352                      label);
353   chart_write_xlabel (dnp_chart, _("Observed Value"));
354   chart_write_ylabel (dnp_chart, _("Dev from Normal"));
355
356   yfirst = gsl_cdf_ugaussian_Pinv (1 / (np->n + 1));
357   ylast = gsl_cdf_ugaussian_Pinv (np->n / (np->n + 1));
358
359   /* Need to make sure that both the scatter plot and the ideal fit into the
360      plot */
361   x_lower = MIN (np->y_min, (yfirst - intercept) / slope) ;
362   x_upper = MAX (np->y_max, (ylast  - intercept) / slope) ;
363   slack = (x_upper - x_lower)  * 0.05 ;
364
365   chart_write_xscale (np_chart, x_lower - slack, x_upper + slack, 5);
366   chart_write_xscale (dnp_chart, np->y_min, np->y_max, 5);
367
368   chart_write_yscale (np_chart, yfirst, ylast, 5);
369   chart_write_yscale (dnp_chart, np->dns_min, np->dns_max, 5);
370
371   {
372     struct ccase c;
373     struct casereader *reader = casewriter_make_reader (np->writer);
374     while (casereader_read (reader, &c))
375       {
376         chart_datum (np_chart, 0, case_data_idx (&c, NP_IDX_Y)->f, case_data_idx (&c, NP_IDX_NS)->f);
377         chart_datum (dnp_chart, 0, case_data_idx (&c, NP_IDX_Y)->f, case_data_idx (&c, NP_IDX_DNS)->f);
378
379         case_destroy (&c);
380       }
381     casereader_destroy (reader);
382   }
383
384   chart_line (dnp_chart, 0, 0, np->y_min, np->y_max , CHART_DIM_X);
385   chart_line (np_chart, slope, intercept, yfirst, ylast , CHART_DIM_Y);
386
387   chart_submit (np_chart);
388   chart_submit (dnp_chart);
389 }
390
391
392 static void
393 show_npplot (const struct variable **dependent_var,
394              int n_dep_var,
395              const struct xfactor *fctr)
396 {
397   int v;
398
399   for (v = 0; v < n_dep_var; ++v)
400     {
401       struct ll *ll;
402       for (ll = ll_head (&fctr->result_list);
403            ll != ll_null (&fctr->result_list);
404            ll = ll_next (ll))
405         {
406           struct string str;
407           const struct factor_result *result =
408             ll_data (ll, struct factor_result, ll);
409
410           ds_init_empty (&str);
411           ds_put_format (&str, "%s ", var_get_name (dependent_var[v]));
412
413           factor_to_string (fctr, result, &str);
414
415           np_plot ((struct np*) result->metrics[v].np, ds_cstr(&str));
416
417           statistic_destroy ((struct statistic *)result->metrics[v].np);
418
419           ds_destroy (&str);
420         }
421     }
422 }
423
424
425 static void
426 show_histogram (const struct variable **dependent_var,
427                 int n_dep_var,
428                 const struct xfactor *fctr)
429 {
430   int v;
431
432   for (v = 0; v < n_dep_var; ++v)
433     {
434       struct ll *ll;
435       for (ll = ll_head (&fctr->result_list);
436            ll != ll_null (&fctr->result_list);
437            ll = ll_next (ll))
438         {
439           struct string str;
440           const struct factor_result *result =
441             ll_data (ll, struct factor_result, ll);
442
443           ds_init_empty (&str);
444           ds_put_format (&str, "%s ", var_get_name (dependent_var[v]));
445
446           factor_to_string (fctr, result, &str);
447
448           histogram_plot ((struct histogram *) result->metrics[v].histogram,
449                           ds_cstr (&str),
450                           (struct moments1 *) result->metrics[v].moments);
451
452           ds_destroy (&str);
453         }
454     }
455 }
456
457
458
459 static void
460 show_boxplot_groups (const struct variable **dependent_var,
461                      int n_dep_var,
462                      const struct xfactor *fctr)
463 {
464   int v;
465
466   for (v = 0; v < n_dep_var; ++v)
467     {
468       struct ll *ll;
469       int f = 0;
470       struct chart *ch = chart_create ();
471       double y_min = DBL_MAX;
472       double y_max = -DBL_MAX;
473
474       for (ll = ll_head (&fctr->result_list);
475            ll != ll_null (&fctr->result_list);
476            ll = ll_next (ll))
477         {
478           const struct extremum  *max, *min;
479           const struct factor_result *result =
480             ll_data (ll, struct factor_result, ll);
481
482           const struct ll_list *max_list =
483             extrema_list (result->metrics[v].maxima);
484
485           const struct ll_list *min_list =
486             extrema_list (result->metrics[v].minima);
487
488           if ( ll_is_empty (max_list))
489             {
490               msg (MW, _("Not creating plot because data set is empty."));
491               continue;
492             }
493
494           max = (const struct extremum *)
495             ll_data (ll_head(max_list), struct extremum, ll);
496
497           min = (const struct extremum *)
498             ll_data (ll_head (min_list), struct extremum, ll);
499
500           y_max = MAX (y_max, max->value);
501           y_min = MIN (y_min, min->value);
502         }
503
504       boxplot_draw_yscale (ch, y_max, y_min);
505
506       if ( fctr->indep_var[0])
507         chart_write_title (ch, _("Boxplot of %s vs. %s"),
508                            var_to_string (dependent_var[v]),
509                            var_to_string (fctr->indep_var[0]) );
510       else
511         chart_write_title (ch, _("Boxplot of %s"),
512                            var_to_string (dependent_var[v]));
513
514       for (ll = ll_head (&fctr->result_list);
515            ll != ll_null (&fctr->result_list);
516            ll = ll_next (ll))
517         {
518           const struct factor_result *result =
519             ll_data (ll, struct factor_result, ll);
520
521           struct string str;
522           const double box_width = (ch->data_right - ch->data_left)
523             / (ll_count (&fctr->result_list) * 2.0 ) ;
524
525           const double box_centre = (f++ * 2 + 1) * box_width + ch->data_left;
526
527           ds_init_empty (&str);
528           factor_to_string_concise (fctr, result, &str);
529
530           boxplot_draw_boxplot (ch,
531                                 box_centre, box_width,
532                                 (const struct box_whisker *)
533                                  result->metrics[v].box_whisker,
534                                 ds_cstr (&str));
535
536           ds_destroy (&str);
537         }
538
539       chart_submit (ch);
540     }
541 }
542
543
544
545 static void
546 show_boxplot_variables (const struct variable **dependent_var,
547                         int n_dep_var,
548                         const struct xfactor *fctr
549                         )
550
551 {
552   int v;
553   struct ll *ll;
554   const struct ll_list *result_list = &fctr->result_list;
555
556   for (ll = ll_head (result_list);
557        ll != ll_null (result_list);
558        ll = ll_next (ll))
559
560     {
561       struct string title;
562       struct chart *ch = chart_create ();
563       double y_min = DBL_MAX;
564       double y_max = -DBL_MAX;
565
566       const struct factor_result *result =
567         ll_data (ll, struct factor_result, ll);
568
569       const double box_width = (ch->data_right - ch->data_left)
570         / (n_dep_var * 2.0 ) ;
571
572       for (v = 0; v < n_dep_var; ++v)
573         {
574           const struct ll *max_ll =
575             ll_head (extrema_list (result->metrics[v].maxima));
576           const struct ll *min_ll =
577             ll_head (extrema_list (result->metrics[v].minima));
578
579           const struct extremum  *max =
580             (const struct extremum *) ll_data (max_ll, struct extremum, ll);
581
582           const struct extremum  *min =
583             (const struct extremum *) ll_data (min_ll, struct extremum, ll);
584
585           y_max = MAX (y_max, max->value);
586           y_min = MIN (y_min, min->value);
587         }
588
589
590       boxplot_draw_yscale (ch, y_max, y_min);
591
592       ds_init_empty (&title);
593       factor_to_string (fctr, result, &title);
594
595 #if 0
596       ds_put_format (&title, "%s = ", var_get_name (fctr->indep_var[0]));
597       var_append_value_name (fctr->indep_var[0], result->value[0], &title);
598 #endif
599
600       chart_write_title (ch, ds_cstr (&title));
601       ds_destroy (&title);
602
603       for (v = 0; v < n_dep_var; ++v)
604         {
605           struct string str;
606           const double box_centre = (v * 2 + 1) * box_width + ch->data_left;
607
608           ds_init_empty (&str);
609           ds_init_cstr (&str, var_get_name (dependent_var[v]));
610
611           boxplot_draw_boxplot (ch,
612                                 box_centre, box_width,
613                                 (const struct box_whisker *) result->metrics[v].box_whisker,
614                                 ds_cstr (&str));
615
616           ds_destroy (&str);
617         }
618
619       chart_submit (ch);
620     }
621 }
622
623
624 /* Show all the appropriate tables */
625 static void
626 output_examine (void)
627 {
628   struct ll *ll;
629
630   show_summary (dependent_vars, n_dependent_vars, &level0_factor);
631
632   if ( cmd.a_statistics[XMN_ST_EXTREME] )
633     show_extremes (dependent_vars, n_dependent_vars, &level0_factor);
634
635   if ( cmd.a_statistics[XMN_ST_DESCRIPTIVES] )
636     show_descriptives (dependent_vars, n_dependent_vars, &level0_factor);
637
638   if ( cmd.sbc_percentiles)
639     show_percentiles (dependent_vars, n_dependent_vars, &level0_factor);
640
641   if ( cmd.sbc_plot)
642     {
643       if (cmd.a_plot[XMN_PLT_BOXPLOT])
644         show_boxplot_groups (dependent_vars, n_dependent_vars, &level0_factor);
645
646       if (cmd.a_plot[XMN_PLT_HISTOGRAM])
647         show_histogram (dependent_vars, n_dependent_vars, &level0_factor);
648
649       if (cmd.a_plot[XMN_PLT_NPPLOT])
650         show_npplot (dependent_vars, n_dependent_vars, &level0_factor);
651     }
652
653   for (ll = ll_head (&factor_list);
654        ll != ll_null (&factor_list); ll = ll_next (ll))
655     {
656       struct xfactor *factor = ll_data (ll, struct xfactor, ll);
657       show_summary (dependent_vars, n_dependent_vars, factor);
658
659       if ( cmd.a_statistics[XMN_ST_EXTREME] )
660         show_extremes (dependent_vars, n_dependent_vars, factor);
661
662       if ( cmd.a_statistics[XMN_ST_DESCRIPTIVES] )
663         show_descriptives (dependent_vars, n_dependent_vars, factor);
664
665       if ( cmd.sbc_percentiles)
666         show_percentiles (dependent_vars, n_dependent_vars, factor);
667
668       if (cmd.a_plot[XMN_PLT_BOXPLOT] &&
669           cmd.cmp == XMN_GROUPS)
670         show_boxplot_groups (dependent_vars, n_dependent_vars, factor);
671
672
673       if (cmd.a_plot[XMN_PLT_BOXPLOT] &&
674           cmd.cmp == XMN_VARIABLES)
675         show_boxplot_variables (dependent_vars, n_dependent_vars,
676                                 factor);
677
678       if (cmd.a_plot[XMN_PLT_HISTOGRAM])
679         show_histogram (dependent_vars, n_dependent_vars, factor);
680
681       if (cmd.a_plot[XMN_PLT_NPPLOT])
682         show_npplot (dependent_vars, n_dependent_vars, factor);
683     }
684 }
685
686 /* Parse the PERCENTILES subcommand */
687 static int
688 xmn_custom_percentiles (struct lexer *lexer, struct dataset *ds UNUSED,
689                         struct cmd_examine *p UNUSED, void *aux UNUSED)
690 {
691   lex_match (lexer, '=');
692
693   lex_match (lexer, '(');
694
695   while ( lex_is_number (lexer) )
696     {
697       subc_list_double_push (&percentile_list, lex_number (lexer));
698
699       lex_get (lexer);
700
701       lex_match (lexer, ',') ;
702     }
703   lex_match (lexer, ')');
704
705   lex_match (lexer, '=');
706
707   if ( lex_match_id (lexer, "HAVERAGE"))
708     percentile_algorithm = PC_HAVERAGE;
709
710   else if ( lex_match_id (lexer, "WAVERAGE"))
711     percentile_algorithm = PC_WAVERAGE;
712
713   else if ( lex_match_id (lexer, "ROUND"))
714     percentile_algorithm = PC_ROUND;
715
716   else if ( lex_match_id (lexer, "EMPIRICAL"))
717     percentile_algorithm = PC_EMPIRICAL;
718
719   else if ( lex_match_id (lexer, "AEMPIRICAL"))
720     percentile_algorithm = PC_AEMPIRICAL;
721
722   else if ( lex_match_id (lexer, "NONE"))
723     percentile_algorithm = PC_NONE;
724
725
726   if ( 0 == subc_list_double_count (&percentile_list))
727     {
728       subc_list_double_push (&percentile_list, 5);
729       subc_list_double_push (&percentile_list, 10);
730       subc_list_double_push (&percentile_list, 25);
731       subc_list_double_push (&percentile_list, 50);
732       subc_list_double_push (&percentile_list, 75);
733       subc_list_double_push (&percentile_list, 90);
734       subc_list_double_push (&percentile_list, 95);
735     }
736
737   return 1;
738 }
739
740 /* TOTAL and NOTOTAL are simple, mutually exclusive flags */
741 static int
742 xmn_custom_total (struct lexer *lexer UNUSED, struct dataset *ds UNUSED,
743                   struct cmd_examine *p, void *aux UNUSED)
744 {
745   if ( p->sbc_nototal )
746     {
747       msg (SE, _("%s and %s are mutually exclusive"),"TOTAL","NOTOTAL");
748       return 0;
749     }
750
751   return 1;
752 }
753
754 static int
755 xmn_custom_nototal (struct lexer *lexer UNUSED, struct dataset *ds UNUSED,
756                     struct cmd_examine *p, void *aux UNUSED)
757 {
758   if ( p->sbc_total )
759     {
760       msg (SE, _("%s and %s are mutually exclusive"), "TOTAL", "NOTOTAL");
761       return 0;
762     }
763
764   return 1;
765 }
766
767
768
769 /* Parser for the variables sub command
770    Returns 1 on success */
771 static int
772 xmn_custom_variables (struct lexer *lexer, struct dataset *ds,
773                       struct cmd_examine *cmd,
774                       void *aux UNUSED)
775 {
776   const struct dictionary *dict = dataset_dict (ds);
777   lex_match (lexer, '=');
778
779   if ( (lex_token (lexer) != T_ID || dict_lookup_var (dict, lex_tokid (lexer)) == NULL)
780        && lex_token (lexer) != T_ALL)
781     {
782       return 2;
783     }
784
785   if (!parse_variables_const (lexer, dict, &dependent_vars, &n_dependent_vars,
786                               PV_NO_DUPLICATE | PV_NUMERIC | PV_NO_SCRATCH) )
787     {
788       free (dependent_vars);
789       return 0;
790     }
791
792   assert (n_dependent_vars);
793
794
795   if ( lex_match (lexer, T_BY))
796     {
797       int success ;
798       success =  examine_parse_independent_vars (lexer, dict, cmd);
799       if ( success != 1 )
800         {
801           free (dependent_vars);
802         }
803       return success;
804     }
805
806   return 1;
807 }
808
809
810
811 /* Parse the clause specifying the factors */
812 static int
813 examine_parse_independent_vars (struct lexer *lexer,
814                                 const struct dictionary *dict,
815                                 struct cmd_examine *cmd)
816 {
817   int success;
818   struct xfactor *sf = xmalloc (sizeof *sf);
819
820   ll_init (&sf->result_list);
821
822   if ( (lex_token (lexer) != T_ID ||
823         dict_lookup_var (dict, lex_tokid (lexer)) == NULL)
824        && lex_token (lexer) != T_ALL)
825     {
826       free ( sf ) ;
827       return 2;
828     }
829
830   sf->indep_var[0] = parse_variable (lexer, dict);
831   sf->indep_var[1] = NULL;
832
833   if ( lex_token (lexer) == T_BY )
834     {
835       lex_match (lexer, T_BY);
836
837       if ( (lex_token (lexer) != T_ID ||
838             dict_lookup_var (dict, lex_tokid (lexer)) == NULL)
839            && lex_token (lexer) != T_ALL)
840         {
841           free (sf);
842           return 2;
843         }
844
845       sf->indep_var[1] = parse_variable (lexer, dict);
846
847       ll_push_tail (&factor_list, &sf->ll);
848     }
849   else
850     ll_push_tail (&factor_list, &sf->ll);
851
852   lex_match (lexer, ',');
853
854   if ( lex_token (lexer) == '.' || lex_token (lexer) == '/' )
855     return 1;
856
857   success =  examine_parse_independent_vars (lexer, dict, cmd);
858
859   if ( success != 1 )
860     free ( sf ) ;
861
862   return success;
863 }
864
865 static void
866 examine_group (struct cmd_examine *cmd, struct casereader *reader, int level,
867                const struct dictionary *dict, struct xfactor *factor)
868 {
869   struct ccase c;
870   const struct variable *wv = dict_get_weight (dict);
871   int v;
872   int n_extrema = 1;
873   struct factor_result *result = xzalloc (sizeof (*result));
874
875   result->metrics = xcalloc (n_dependent_vars, sizeof (*result->metrics));
876
877   if ( cmd->a_statistics[XMN_ST_EXTREME] )
878     n_extrema = cmd->st_n;
879
880
881   if (casereader_peek (reader, 0, &c))
882     {
883       if ( level > 0)
884         {
885           result->value[0] =
886             value_dup (case_data (&c, factor->indep_var[0]),
887                        var_get_width (factor->indep_var[0]));
888
889           if ( level > 1)
890             result->value[1] =
891               value_dup (case_data (&c, factor->indep_var[1]),
892                          var_get_width (factor->indep_var[1]));
893         }
894       case_destroy (&c);
895     }
896
897   for (v = 0; v < n_dependent_vars; ++v)
898     {
899       struct casewriter *writer;
900       struct casereader *input = casereader_clone (reader);
901
902       result->metrics[v].moments = moments1_create (MOMENT_KURTOSIS);
903       result->metrics[v].minima = extrema_create (n_extrema, EXTREME_MINIMA);
904       result->metrics[v].maxima = extrema_create (n_extrema, EXTREME_MAXIMA);
905       result->metrics[v].cmin = DBL_MAX;
906
907       if (cmd->a_statistics[XMN_ST_DESCRIPTIVES] ||
908           cmd->a_plot[XMN_PLT_BOXPLOT] ||
909           cmd->a_plot[XMN_PLT_NPPLOT] ||
910           cmd->sbc_percentiles)
911         {
912           /* In this case, we need to sort the data, so we create a sorting
913              casewriter */
914           struct case_ordering *up_ordering = case_ordering_create ();
915
916           case_ordering_add_var (up_ordering, dependent_vars[v], SRT_ASCEND);
917           writer = sort_create_writer (up_ordering,
918                                        casereader_get_value_cnt (reader));
919         }
920       else
921         {
922           /* but in this case, sorting is unnecessary, so an ordinary
923              casewriter is sufficient */
924           writer =
925             autopaging_writer_create (casereader_get_value_cnt (reader));
926         }
927
928
929       /* Sort or just iterate, whilst calculating moments etc */
930       while (casereader_read (input, &c))
931         {
932           const casenumber loc =
933               case_data_idx (&c, casereader_get_value_cnt (reader) - 1)->f;
934
935           const double weight = wv ? case_data (&c, wv)->f : 1.0;
936
937           if (weight != SYSMIS)
938             minimize (&result->metrics[v].cmin, weight);
939
940           moments1_add (result->metrics[v].moments,
941                         case_data (&c, dependent_vars[v])->f,
942                         weight);
943
944           result->metrics[v].n += weight;
945
946           extrema_add (result->metrics[v].maxima,
947                        case_data (&c, dependent_vars[v])->f,
948                        weight,
949                        loc);
950
951           extrema_add (result->metrics[v].minima,
952                        case_data (&c, dependent_vars[v])->f,
953                        weight,
954                        loc);
955
956           casewriter_write (writer, &c);
957         }
958       casereader_destroy (input);
959       result->metrics[v].up_reader = casewriter_make_reader (writer);
960     }
961
962   /* If percentiles or descriptives have been requested, then a
963      second pass through the data (which has now been sorted)
964      is necessary */
965   if ( cmd->a_statistics[XMN_ST_DESCRIPTIVES] ||
966        cmd->a_plot[XMN_PLT_BOXPLOT] ||
967        cmd->a_plot[XMN_PLT_NPPLOT] ||
968        cmd->sbc_percentiles)
969     {
970       for (v = 0; v < n_dependent_vars; ++v)
971         {
972           int i;
973           int n_os;
974           struct order_stats **os ;
975           struct factor_metrics *metric = &result->metrics[v];
976
977           metric->n_ptiles = percentile_list.n_data;
978
979           metric->ptl = xcalloc (metric->n_ptiles,
980                                  sizeof (struct percentile *));
981
982           metric->quartiles = xcalloc (3, sizeof (*metric->quartiles));
983
984           for (i = 0 ; i < metric->n_ptiles; ++i)
985             {
986               metric->ptl[i] = (struct percentile *)
987                 percentile_create (percentile_list.data[i] / 100.0, metric->n);
988
989               if ( percentile_list.data[i] == 25)
990                 metric->quartiles[0] = metric->ptl[i];
991               else if ( percentile_list.data[i] == 50)
992                 metric->quartiles[1] = metric->ptl[i];
993               else if ( percentile_list.data[i] == 75)
994                 metric->quartiles[2] = metric->ptl[i];
995             }
996
997           metric->tukey_hinges = tukey_hinges_create (metric->n, metric->cmin);
998           metric->trimmed_mean = trimmed_mean_create (metric->n, 0.05);
999
1000           n_os = metric->n_ptiles + 2;
1001
1002          if ( cmd->a_plot[XMN_PLT_NPPLOT] )
1003             {
1004               metric->np = np_create (metric->moments);
1005               n_os ++;
1006             }
1007
1008           os = xcalloc (sizeof (struct order_stats *), n_os);
1009
1010           for (i = 0 ; i < metric->n_ptiles ; ++i )
1011             {
1012               os[i] = (struct order_stats *) metric->ptl[i];
1013             }
1014
1015           os[i] = (struct order_stats *) metric->tukey_hinges;
1016           os[i+1] = (struct order_stats *) metric->trimmed_mean;
1017
1018           if (cmd->a_plot[XMN_PLT_NPPLOT])
1019             os[i+2] = metric->np;
1020
1021           order_stats_accumulate (os, n_os,
1022                                   casereader_clone (metric->up_reader),
1023                                   wv, dependent_vars[v], MV_ANY);
1024           free (os);
1025         }
1026     }
1027
1028   /* FIXME: Do this in the above loop */
1029   if ( cmd->a_plot[XMN_PLT_HISTOGRAM] )
1030     {
1031       struct ccase c;
1032       struct casereader *input = casereader_clone (reader);
1033
1034       for (v = 0; v < n_dependent_vars; ++v)
1035         {
1036           const struct extremum  *max, *min;
1037           struct factor_metrics *metric = &result->metrics[v];
1038
1039           const struct ll_list *max_list =
1040             extrema_list (result->metrics[v].maxima);
1041
1042           const struct ll_list *min_list =
1043             extrema_list (result->metrics[v].minima);
1044
1045           if ( ll_is_empty (max_list))
1046             {
1047               msg (MW, _("Not creating plot because data set is empty."));
1048               continue;
1049             }
1050
1051           assert (! ll_is_empty (min_list));
1052
1053           max = (const struct extremum *)
1054             ll_data (ll_head(max_list), struct extremum, ll);
1055
1056           min = (const struct extremum *)
1057             ll_data (ll_head (min_list), struct extremum, ll);
1058
1059           metric->histogram = histogram_create (10, min->value, max->value);
1060         }
1061
1062       while (casereader_read (input, &c))
1063         {
1064           const double weight = wv ? case_data (&c, wv)->f : 1.0;
1065
1066           for (v = 0; v < n_dependent_vars; ++v)
1067             {
1068               struct factor_metrics *metric = &result->metrics[v];
1069               if ( metric->histogram)
1070                 histogram_add ((struct histogram *) metric->histogram,
1071                                case_data (&c, dependent_vars[v])->f, weight);
1072             }
1073           case_destroy (&c);
1074         }
1075       casereader_destroy (input);
1076     }
1077
1078   /* In this case, a third iteration is required */
1079   if (cmd->a_plot[XMN_PLT_BOXPLOT])
1080     {
1081       for (v = 0; v < n_dependent_vars; ++v)
1082         {
1083           struct factor_metrics *metric = &result->metrics[v];
1084
1085           metric->box_whisker =
1086             box_whisker_create ((struct tukey_hinges *) metric->tukey_hinges,
1087                                 cmd->v_id,
1088                                 casereader_get_value_cnt (metric->up_reader)
1089                                 - 1);
1090
1091           order_stats_accumulate ((struct order_stats **) &metric->box_whisker,
1092                                   1,
1093                                   casereader_clone (metric->up_reader),
1094                                   wv, dependent_vars[v], MV_ANY);
1095         }
1096     }
1097
1098   ll_push_tail (&factor->result_list, &result->ll);
1099   casereader_destroy (reader);
1100 }
1101
1102
1103 static void
1104 run_examine (struct cmd_examine *cmd, struct casereader *input,
1105              struct dataset *ds)
1106 {
1107   struct ll *ll;
1108   const struct dictionary *dict = dataset_dict (ds);
1109   struct ccase c;
1110   struct casereader *level0 = casereader_clone (input);
1111
1112   if (!casereader_peek (input, 0, &c))
1113     {
1114       casereader_destroy (input);
1115       return;
1116     }
1117
1118   output_split_file_values (ds, &c);
1119   case_destroy (&c);
1120
1121   ll_init (&level0_factor.result_list);
1122
1123   examine_group (cmd, level0, 0, dict, &level0_factor);
1124
1125   for (ll = ll_head (&factor_list);
1126        ll != ll_null (&factor_list);
1127        ll = ll_next (ll))
1128     {
1129       struct xfactor *factor = ll_data (ll, struct xfactor, ll);
1130
1131       struct casereader *group = NULL;
1132       struct casereader *level1;
1133       struct casegrouper *grouper1 = NULL;
1134       struct case_ordering *ordering1 = case_ordering_create ();
1135       case_ordering_add_var (ordering1, factor->indep_var[0], SRT_ASCEND);
1136
1137       level1 = casereader_clone (input);
1138
1139       level1 = sort_execute (level1,
1140                              case_ordering_clone (ordering1));
1141       grouper1 = casegrouper_create_case_ordering (level1, ordering1);
1142       case_ordering_destroy (ordering1);
1143
1144       while (casegrouper_get_next_group (grouper1, &group))
1145         {
1146           struct casereader *group_copy = casereader_clone (group);
1147
1148           if ( !factor->indep_var[1])
1149             examine_group (cmd, group_copy, 1, dict, factor);
1150           else
1151             {
1152               int n_groups = 0;
1153               struct casereader *group2 = NULL;
1154               struct casegrouper *grouper2 = NULL;
1155               struct case_ordering *ordering2 = case_ordering_create ();
1156
1157               case_ordering_add_var (ordering2,
1158                                      factor->indep_var[1], SRT_ASCEND);
1159               group_copy = sort_execute (group_copy,
1160                                      case_ordering_clone (ordering2));
1161               grouper2 =
1162                 casegrouper_create_case_ordering (group_copy, ordering2);
1163
1164               case_ordering_destroy (ordering2);
1165
1166               while (casegrouper_get_next_group (grouper2, &group2))
1167                 {
1168                   examine_group (cmd, group2, 2, dict, factor);
1169                   n_groups++;
1170                 }
1171               casegrouper_destroy (grouper2);
1172             }
1173
1174           casereader_destroy (group);
1175         }
1176       casegrouper_destroy (grouper1);
1177     }
1178
1179   casereader_destroy (input);
1180
1181   output_examine ();
1182
1183   factor_destroy (&level0_factor);
1184
1185   {
1186     struct ll *ll;
1187     for (ll = ll_head (&factor_list);
1188          ll != ll_null (&factor_list);
1189          ll = ll_next (ll))
1190       {
1191         struct xfactor *f = ll_data (ll, struct xfactor, ll);
1192         factor_destroy (f);
1193       }
1194   }
1195
1196 }
1197
1198
1199 static void
1200 show_summary (const struct variable **dependent_var, int n_dep_var,
1201               const struct xfactor *fctr)
1202 {
1203   static const char *subtitle[]=
1204     {
1205       N_("Valid"),
1206       N_("Missing"),
1207       N_("Total")
1208     };
1209
1210   int v, j;
1211   int heading_columns = 1;
1212   int n_cols;
1213   const int heading_rows = 3;
1214   struct tab_table *tbl;
1215
1216   int n_rows ;
1217   n_rows = n_dep_var;
1218
1219   assert (fctr);
1220
1221   if ( fctr->indep_var[0] )
1222     {
1223       heading_columns = 2;
1224
1225       if ( fctr->indep_var[1] )
1226         {
1227           heading_columns = 3;
1228         }
1229     }
1230
1231   n_rows *= ll_count (&fctr->result_list);
1232   n_rows += heading_rows;
1233
1234   n_cols = heading_columns + 6;
1235
1236   tbl = tab_create (n_cols, n_rows, 0);
1237   tab_headers (tbl, heading_columns, 0, heading_rows, 0);
1238
1239   tab_dim (tbl, tab_natural_dimensions);
1240
1241   /* Outline the box */
1242   tab_box (tbl,
1243            TAL_2, TAL_2,
1244            -1, -1,
1245            0, 0,
1246            n_cols - 1, n_rows - 1);
1247
1248   /* Vertical lines for the data only */
1249   tab_box (tbl,
1250            -1, -1,
1251            -1, TAL_1,
1252            heading_columns, 0,
1253            n_cols - 1, n_rows - 1);
1254
1255
1256   tab_hline (tbl, TAL_2, 0, n_cols - 1, heading_rows );
1257   tab_hline (tbl, TAL_1, heading_columns, n_cols - 1, 1 );
1258   tab_hline (tbl, TAL_1, heading_columns, n_cols - 1, heading_rows -1 );
1259
1260   tab_vline (tbl, TAL_2, heading_columns, 0, n_rows - 1);
1261
1262
1263   tab_title (tbl, _("Case Processing Summary"));
1264
1265   tab_joint_text (tbl, heading_columns, 0,
1266                   n_cols -1, 0,
1267                   TAB_CENTER | TAT_TITLE,
1268                   _("Cases"));
1269
1270   /* Remove lines ... */
1271   tab_box (tbl,
1272            -1, -1,
1273            TAL_0, TAL_0,
1274            heading_columns, 0,
1275            n_cols - 1, 0);
1276
1277   for (j = 0 ; j < 3 ; ++j)
1278     {
1279       tab_text (tbl, heading_columns + j * 2 , 2, TAB_CENTER | TAT_TITLE,
1280                 _("N"));
1281
1282       tab_text (tbl, heading_columns + j * 2 + 1, 2, TAB_CENTER | TAT_TITLE,
1283                 _("Percent"));
1284
1285       tab_joint_text (tbl, heading_columns + j * 2 , 1,
1286                       heading_columns + j * 2 + 1, 1,
1287                       TAB_CENTER | TAT_TITLE,
1288                       subtitle[j]);
1289
1290       tab_box (tbl, -1, -1,
1291                TAL_0, TAL_0,
1292                heading_columns + j * 2, 1,
1293                heading_columns + j * 2 + 1, 1);
1294     }
1295
1296
1297   /* Titles for the independent variables */
1298   if ( fctr->indep_var[0] )
1299     {
1300       tab_text (tbl, 1, heading_rows - 1, TAB_CENTER | TAT_TITLE,
1301                 var_to_string (fctr->indep_var[0]));
1302
1303       if ( fctr->indep_var[1] )
1304         {
1305           tab_text (tbl, 2, heading_rows - 1, TAB_CENTER | TAT_TITLE,
1306                     var_to_string (fctr->indep_var[1]));
1307         }
1308     }
1309
1310   for (v = 0 ; v < n_dep_var ; ++v)
1311     {
1312       int j = 0;
1313       struct ll *ll;
1314       union value *last_value = NULL;
1315
1316       if ( v > 0 )
1317         tab_hline (tbl, TAL_1, 0, n_cols -1 ,
1318                    v * ll_count (&fctr->result_list)
1319                    + heading_rows);
1320
1321       tab_text (tbl,
1322                 0,
1323                 v * ll_count (&fctr->result_list) + heading_rows,
1324                 TAB_LEFT | TAT_TITLE,
1325                 var_to_string (dependent_var[v])
1326                 );
1327
1328
1329       for (ll = ll_head (&fctr->result_list);
1330            ll != ll_null (&fctr->result_list); ll = ll_next (ll))
1331         {
1332           double n;
1333           const struct factor_result *result =
1334             ll_data (ll, struct factor_result, ll);
1335
1336           if ( fctr->indep_var[0] )
1337             {
1338
1339               if ( last_value == NULL ||
1340                    compare_values (last_value, result->value[0],
1341                                    fctr->indep_var[0]))
1342                 {
1343                   struct string str;
1344
1345                   last_value = result->value[0];
1346                   ds_init_empty (&str);
1347
1348                   var_append_value_name (fctr->indep_var[0], result->value[0],
1349                                          &str);
1350
1351                   tab_text (tbl, 1,
1352                             heading_rows + j +
1353                             v * ll_count (&fctr->result_list),
1354                             TAB_LEFT | TAT_TITLE,
1355                             ds_cstr (&str));
1356
1357                   ds_destroy (&str);
1358
1359                   if ( fctr->indep_var[1] && j > 0)
1360                     tab_hline (tbl, TAL_1, 1, n_cols - 1,
1361                                heading_rows + j +
1362                                v * ll_count (&fctr->result_list));
1363                 }
1364
1365               if ( fctr->indep_var[1])
1366                 {
1367                   struct string str;
1368
1369                   ds_init_empty (&str);
1370
1371                   var_append_value_name (fctr->indep_var[1],
1372                                          result->value[1], &str);
1373
1374                   tab_text (tbl, 2,
1375                             heading_rows + j +
1376                             v * ll_count (&fctr->result_list),
1377                             TAB_LEFT | TAT_TITLE,
1378                             ds_cstr (&str));
1379
1380                   ds_destroy (&str);
1381                 }
1382             }
1383
1384
1385           moments1_calculate (result->metrics[v].moments,
1386                               &n, &result->metrics[v].mean,
1387                               &result->metrics[v].variance,
1388                               &result->metrics[v].skewness,
1389                               &result->metrics[v].kurtosis);
1390
1391           result->metrics[v].se_mean = sqrt (result->metrics[v].variance / n) ;
1392
1393           /* Total Valid */
1394           tab_float (tbl, heading_columns,
1395                      heading_rows + j + v * ll_count (&fctr->result_list),
1396                      TAB_LEFT,
1397                      n, 8, 0);
1398
1399           tab_text (tbl, heading_columns + 1,
1400                     heading_rows + j + v * ll_count (&fctr->result_list),
1401                     TAB_RIGHT | TAT_PRINTF,
1402                     "%g%%", n * 100.0 / result->metrics[v].n);
1403
1404           /* Total Missing */
1405           tab_float (tbl, heading_columns + 2,
1406                      heading_rows + j + v * ll_count (&fctr->result_list),
1407                      TAB_LEFT,
1408                      result->metrics[v].n - n,
1409                      8, 0);
1410
1411           tab_text (tbl, heading_columns + 3,
1412                     heading_rows + j + v * ll_count (&fctr->result_list),
1413                     TAB_RIGHT | TAT_PRINTF,
1414                     "%g%%",
1415                     (result->metrics[v].n - n) * 100.0 / result->metrics[v].n
1416                     );
1417
1418           /* Total Valid + Missing */
1419           tab_float (tbl, heading_columns + 4,
1420                      heading_rows + j + v * ll_count (&fctr->result_list),
1421                      TAB_LEFT,
1422                      result->metrics[v].n,
1423                      8, 0);
1424
1425           tab_text (tbl, heading_columns + 5,
1426                     heading_rows + j + v * ll_count (&fctr->result_list),
1427                     TAB_RIGHT | TAT_PRINTF,
1428                     "%g%%",
1429                     (result->metrics[v].n) * 100.0 / result->metrics[v].n
1430                     );
1431
1432           ++j;
1433         }
1434     }
1435
1436
1437   tab_submit (tbl);
1438 }
1439
1440 #define DESCRIPTIVE_ROWS 13
1441
1442 static void
1443 show_descriptives (const struct variable **dependent_var,
1444                    int n_dep_var,
1445                    const struct xfactor *fctr)
1446 {
1447   int v;
1448   int heading_columns = 3;
1449   int n_cols;
1450   const int heading_rows = 1;
1451   struct tab_table *tbl;
1452
1453   int n_rows ;
1454   n_rows = n_dep_var;
1455
1456   assert (fctr);
1457
1458   if ( fctr->indep_var[0] )
1459     {
1460       heading_columns = 4;
1461
1462       if ( fctr->indep_var[1] )
1463         {
1464           heading_columns = 5;
1465         }
1466     }
1467
1468   n_rows *= ll_count (&fctr->result_list) * DESCRIPTIVE_ROWS;
1469   n_rows += heading_rows;
1470
1471   n_cols = heading_columns + 2;
1472
1473   tbl = tab_create (n_cols, n_rows, 0);
1474   tab_headers (tbl, heading_columns, 0, heading_rows, 0);
1475
1476   tab_dim (tbl, tab_natural_dimensions);
1477
1478   /* Outline the box */
1479   tab_box (tbl,
1480            TAL_2, TAL_2,
1481            -1, -1,
1482            0, 0,
1483            n_cols - 1, n_rows - 1);
1484
1485
1486   tab_hline (tbl, TAL_2, 0, n_cols - 1, heading_rows );
1487   tab_hline (tbl, TAL_2, 1, n_cols - 1, heading_rows );
1488
1489   tab_vline (tbl, TAL_1, n_cols - 1, 0, n_rows - 1);
1490
1491
1492   if ( fctr->indep_var[0])
1493     tab_text (tbl, 1, 0, TAT_TITLE, var_to_string (fctr->indep_var[0]));
1494
1495   if ( fctr->indep_var[1])
1496     tab_text (tbl, 2, 0, TAT_TITLE, var_to_string (fctr->indep_var[1]));
1497
1498   for (v = 0 ; v < n_dep_var ; ++v )
1499     {
1500       struct ll *ll;
1501       int i = 0;
1502
1503       const int row_var_start =
1504         v * DESCRIPTIVE_ROWS * ll_count(&fctr->result_list);
1505
1506       tab_text (tbl,
1507                 0,
1508                 heading_rows + row_var_start,
1509                 TAB_LEFT | TAT_TITLE,
1510                 var_to_string (dependent_var[v])
1511                 );
1512
1513       for (ll = ll_head (&fctr->result_list);
1514            ll != ll_null (&fctr->result_list); i++, ll = ll_next (ll))
1515         {
1516           const struct factor_result *result =
1517             ll_data (ll, struct factor_result, ll);
1518
1519           const double t =
1520             gsl_cdf_tdist_Qinv ((1 - cmd.n_cinterval[0] / 100.0) / 2.0,
1521                                       result->metrics[v].n - 1);
1522
1523           if ( i > 0 || v > 0 )
1524             {
1525               const int left_col = (i == 0) ? 0 : 1;
1526               tab_hline (tbl, TAL_1, left_col, n_cols - 1,
1527                          heading_rows + row_var_start + i * DESCRIPTIVE_ROWS);
1528             }
1529
1530           if ( fctr->indep_var[0])
1531             {
1532               struct string vstr;
1533               ds_init_empty (&vstr);
1534               var_append_value_name (fctr->indep_var[0],
1535                                      result->value[0], &vstr);
1536
1537               tab_text (tbl, 1,
1538                         heading_rows + row_var_start + i * DESCRIPTIVE_ROWS,
1539                         TAB_LEFT,
1540                         ds_cstr (&vstr)
1541                         );
1542
1543               ds_destroy (&vstr);
1544             }
1545
1546
1547           tab_text (tbl, n_cols - 4,
1548                     heading_rows + row_var_start + i * DESCRIPTIVE_ROWS,
1549                     TAB_LEFT,
1550                     _("Mean"));
1551
1552           tab_text (tbl, n_cols - 4,
1553                     heading_rows + row_var_start + 1 + i * DESCRIPTIVE_ROWS,
1554                     TAB_LEFT | TAT_PRINTF,
1555                     _("%g%% Confidence Interval for Mean"),
1556                     cmd.n_cinterval[0]);
1557
1558           tab_text (tbl, n_cols - 3,
1559                     heading_rows + row_var_start + 1 + i * DESCRIPTIVE_ROWS,
1560                     TAB_LEFT,
1561                     _("Lower Bound"));
1562
1563           tab_text (tbl, n_cols - 3,
1564                     heading_rows + row_var_start + 2 + i * DESCRIPTIVE_ROWS,
1565                     TAB_LEFT,
1566                     _("Upper Bound"));
1567
1568           tab_text (tbl, n_cols - 4,
1569                     heading_rows + row_var_start + 3 + i * DESCRIPTIVE_ROWS,
1570                     TAB_LEFT | TAT_PRINTF,
1571                     _("5%% Trimmed Mean"));
1572
1573           tab_text (tbl, n_cols - 4,
1574                     heading_rows + row_var_start + 4 + i * DESCRIPTIVE_ROWS,
1575                     TAB_LEFT,
1576                     _("Median"));
1577
1578           tab_text (tbl, n_cols - 4,
1579                     heading_rows + row_var_start + 5 + i * DESCRIPTIVE_ROWS,
1580                     TAB_LEFT,
1581                     _("Variance"));
1582
1583           tab_text (tbl, n_cols - 4,
1584                     heading_rows + row_var_start + 6 + i * DESCRIPTIVE_ROWS,
1585                     TAB_LEFT,
1586                     _("Std. Deviation"));
1587
1588           tab_text (tbl, n_cols - 4,
1589                     heading_rows + row_var_start + 7 + i * DESCRIPTIVE_ROWS,
1590                     TAB_LEFT,
1591                     _("Minimum"));
1592
1593           tab_text (tbl, n_cols - 4,
1594                     heading_rows + row_var_start + 8 + i * DESCRIPTIVE_ROWS,
1595                     TAB_LEFT,
1596                     _("Maximum"));
1597
1598           tab_text (tbl, n_cols - 4,
1599                     heading_rows + row_var_start + 9 + i * DESCRIPTIVE_ROWS,
1600                     TAB_LEFT,
1601                     _("Range"));
1602
1603           tab_text (tbl, n_cols - 4,
1604                     heading_rows + row_var_start + 10 + i * DESCRIPTIVE_ROWS,
1605                     TAB_LEFT,
1606                     _("Interquartile Range"));
1607
1608
1609           tab_text (tbl, n_cols - 4,
1610                     heading_rows + row_var_start + 11 + i * DESCRIPTIVE_ROWS,
1611                     TAB_LEFT,
1612                     _("Skewness"));
1613
1614           tab_text (tbl, n_cols - 4,
1615                     heading_rows + row_var_start + 12 + i * DESCRIPTIVE_ROWS,
1616                     TAB_LEFT,
1617                     _("Kurtosis"));
1618
1619
1620           /* Now the statistics ... */
1621
1622           tab_float (tbl, n_cols - 2,
1623                     heading_rows + row_var_start + i * DESCRIPTIVE_ROWS,
1624                      TAB_CENTER,
1625                      result->metrics[v].mean,
1626                      8, 2);
1627
1628           tab_float (tbl, n_cols - 1,
1629                     heading_rows + row_var_start + i * DESCRIPTIVE_ROWS,
1630                      TAB_CENTER,
1631                      result->metrics[v].se_mean,
1632                      8, 3);
1633
1634
1635           tab_float (tbl, n_cols - 2,
1636                      heading_rows + row_var_start + 1 + i * DESCRIPTIVE_ROWS,
1637                      TAB_CENTER,
1638                      result->metrics[v].mean - t *
1639                       result->metrics[v].se_mean,
1640                      8, 3);
1641
1642           tab_float (tbl, n_cols - 2,
1643                      heading_rows + row_var_start + 2 + i * DESCRIPTIVE_ROWS,
1644                      TAB_CENTER,
1645                      result->metrics[v].mean + t *
1646                       result->metrics[v].se_mean,
1647                      8, 3);
1648
1649
1650           tab_float (tbl, n_cols - 2,
1651                      heading_rows + row_var_start + 3 + i * DESCRIPTIVE_ROWS,
1652                      TAB_CENTER,
1653                      trimmed_mean_calculate ((struct trimmed_mean *) result->metrics[v].trimmed_mean),
1654                      8, 2);
1655
1656
1657           tab_float (tbl, n_cols - 2,
1658                      heading_rows + row_var_start + 4 + i * DESCRIPTIVE_ROWS,
1659                      TAB_CENTER,
1660                      percentile_calculate (result->metrics[v].quartiles[1], percentile_algorithm),
1661                      8, 2);
1662
1663
1664           tab_float (tbl, n_cols - 2,
1665                      heading_rows + row_var_start + 5 + i * DESCRIPTIVE_ROWS,
1666                      TAB_CENTER,
1667                      result->metrics[v].variance,
1668                      8, 3);
1669
1670           tab_float (tbl, n_cols - 2,
1671                      heading_rows + row_var_start + 6 + i * DESCRIPTIVE_ROWS,
1672                      TAB_CENTER,
1673                      sqrt (result->metrics[v].variance),
1674                      8, 3);
1675
1676           tab_float (tbl, n_cols - 2,
1677                      heading_rows + row_var_start + 10 + i * DESCRIPTIVE_ROWS,
1678                      TAB_CENTER,
1679                      percentile_calculate (result->metrics[v].quartiles[2],
1680                                            percentile_algorithm) -
1681                      percentile_calculate (result->metrics[v].quartiles[0],
1682                                            percentile_algorithm),
1683                      8, 2);
1684
1685
1686           tab_float (tbl, n_cols - 2,
1687                      heading_rows + row_var_start + 11 + i * DESCRIPTIVE_ROWS,
1688                      TAB_CENTER,
1689                      result->metrics[v].skewness,
1690                      8, 3);
1691
1692           tab_float (tbl, n_cols - 2,
1693                      heading_rows + row_var_start + 12 + i * DESCRIPTIVE_ROWS,
1694                      TAB_CENTER,
1695                      result->metrics[v].kurtosis,
1696                      8, 3);
1697
1698           tab_float (tbl, n_cols - 1,
1699                      heading_rows + row_var_start + 11 + i * DESCRIPTIVE_ROWS,
1700                      TAB_CENTER,
1701                      calc_seskew (result->metrics[v].n),
1702                      8, 3);
1703
1704           tab_float (tbl, n_cols - 1,
1705                      heading_rows + row_var_start + 12 + i * DESCRIPTIVE_ROWS,
1706                      TAB_CENTER,
1707                      calc_sekurt (result->metrics[v].n),
1708                      8, 3);
1709
1710           {
1711             struct extremum *minimum, *maximum ;
1712
1713             struct ll *max_ll = ll_head (extrema_list (result->metrics[v].maxima));
1714             struct ll *min_ll = ll_head (extrema_list (result->metrics[v].minima));
1715
1716             maximum = ll_data (max_ll, struct extremum, ll);
1717             minimum = ll_data (min_ll, struct extremum, ll);
1718
1719             tab_float (tbl, n_cols - 2,
1720                        heading_rows + row_var_start + 7 + i * DESCRIPTIVE_ROWS,
1721                        TAB_CENTER,
1722                        minimum->value,
1723                        8, 3);
1724
1725             tab_float (tbl, n_cols - 2,
1726                        heading_rows + row_var_start + 8 + i * DESCRIPTIVE_ROWS,
1727                        TAB_CENTER,
1728                        maximum->value,
1729                        8, 3);
1730
1731             tab_float (tbl, n_cols - 2,
1732                        heading_rows + row_var_start + 9 + i * DESCRIPTIVE_ROWS,
1733                        TAB_CENTER,
1734                        maximum->value - minimum->value,
1735                        8, 3);
1736           }
1737         }
1738     }
1739
1740   tab_vline (tbl, TAL_2, heading_columns, 0, n_rows - 1);
1741
1742   tab_title (tbl, _("Descriptives"));
1743
1744   tab_text (tbl, n_cols - 2, 0, TAB_CENTER | TAT_TITLE,
1745             _("Statistic"));
1746
1747   tab_text (tbl, n_cols - 1, 0, TAB_CENTER | TAT_TITLE,
1748             _("Std. Error"));
1749
1750   tab_submit (tbl);
1751 }
1752
1753
1754
1755 static void
1756 show_extremes (const struct variable **dependent_var,
1757                int n_dep_var,
1758                const struct xfactor *fctr)
1759 {
1760   int v;
1761   int heading_columns = 3;
1762   int n_cols;
1763   const int heading_rows = 1;
1764   struct tab_table *tbl;
1765
1766   int n_rows ;
1767   n_rows = n_dep_var;
1768
1769   assert (fctr);
1770
1771   if ( fctr->indep_var[0] )
1772     {
1773       heading_columns = 4;
1774
1775       if ( fctr->indep_var[1] )
1776         {
1777           heading_columns = 5;
1778         }
1779     }
1780
1781   n_rows *= ll_count (&fctr->result_list) * cmd.st_n * 2;
1782   n_rows += heading_rows;
1783
1784   n_cols = heading_columns + 2;
1785
1786   tbl = tab_create (n_cols, n_rows, 0);
1787   tab_headers (tbl, heading_columns, 0, heading_rows, 0);
1788
1789   tab_dim (tbl, tab_natural_dimensions);
1790
1791   /* Outline the box */
1792   tab_box (tbl,
1793            TAL_2, TAL_2,
1794            -1, -1,
1795            0, 0,
1796            n_cols - 1, n_rows - 1);
1797
1798
1799   tab_hline (tbl, TAL_2, 0, n_cols - 1, heading_rows );
1800   tab_hline (tbl, TAL_2, 1, n_cols - 1, heading_rows );
1801   tab_vline (tbl, TAL_1, n_cols - 1, 0, n_rows - 1);
1802
1803   if ( fctr->indep_var[0])
1804     tab_text (tbl, 1, 0, TAT_TITLE, var_to_string (fctr->indep_var[0]));
1805
1806   if ( fctr->indep_var[1])
1807     tab_text (tbl, 2, 0, TAT_TITLE, var_to_string (fctr->indep_var[1]));
1808
1809   for (v = 0 ; v < n_dep_var ; ++v )
1810     {
1811       struct ll *ll;
1812       int i = 0;
1813       const int row_var_start = v * cmd.st_n * 2 * ll_count(&fctr->result_list);
1814
1815       tab_text (tbl,
1816                 0,
1817                 heading_rows + row_var_start,
1818                 TAB_LEFT | TAT_TITLE,
1819                 var_to_string (dependent_var[v])
1820                 );
1821
1822       for (ll = ll_head (&fctr->result_list);
1823            ll != ll_null (&fctr->result_list); i++, ll = ll_next (ll))
1824         {
1825           int e ;
1826           struct ll *min_ll;
1827           struct ll *max_ll;
1828           const int row_result_start = i * cmd.st_n * 2;
1829
1830           const struct factor_result *result =
1831             ll_data (ll, struct factor_result, ll);
1832
1833           if (i > 0 || v > 0)
1834             tab_hline (tbl, TAL_1, 1, n_cols - 1,
1835                        heading_rows + row_var_start + row_result_start);
1836
1837           tab_hline (tbl, TAL_1, heading_columns - 2, n_cols - 1,
1838                      heading_rows + row_var_start + row_result_start + cmd.st_n);
1839
1840           for ( e = 1; e <= cmd.st_n; ++e )
1841             {
1842               tab_text (tbl, n_cols - 3,
1843                         heading_rows + row_var_start + row_result_start + e - 1,
1844                         TAB_RIGHT | TAT_PRINTF,
1845                         _("%d"), e);
1846
1847               tab_text (tbl, n_cols - 3,
1848                         heading_rows + row_var_start + row_result_start + cmd.st_n + e - 1,
1849                         TAB_RIGHT | TAT_PRINTF,
1850                         _("%d"), e);
1851             }
1852
1853
1854           min_ll = ll_head (extrema_list (result->metrics[v].minima));
1855           for (e = 0; e < cmd.st_n;)
1856             {
1857               struct extremum *minimum = ll_data (min_ll, struct extremum, ll);
1858               double weight = minimum->weight;
1859
1860               while (weight-- > 0 && e < cmd.st_n)
1861                 {
1862                   tab_float (tbl, n_cols - 1,
1863                              heading_rows + row_var_start + row_result_start + cmd.st_n + e,
1864                              TAB_RIGHT,
1865                              minimum->value,
1866                              8, 2);
1867
1868
1869                   tab_float (tbl, n_cols - 2,
1870                              heading_rows + row_var_start + row_result_start + cmd.st_n + e,
1871                              TAB_RIGHT,
1872                              minimum->location,
1873                              8, 0);
1874                   ++e;
1875                 }
1876
1877               min_ll = ll_next (min_ll);
1878             }
1879
1880
1881           max_ll = ll_head (extrema_list (result->metrics[v].maxima));
1882           for (e = 0; e < cmd.st_n;)
1883             {
1884               struct extremum *maximum = ll_data (max_ll, struct extremum, ll);
1885               double weight = maximum->weight;
1886
1887               while (weight-- > 0 && e < cmd.st_n)
1888                 {
1889                   tab_float (tbl, n_cols - 1,
1890                              heading_rows + row_var_start + row_result_start + e,
1891                              TAB_RIGHT,
1892                              maximum->value,
1893                              8, 2);
1894
1895
1896                   tab_float (tbl, n_cols - 2,
1897                              heading_rows + row_var_start + row_result_start + e,
1898                              TAB_RIGHT,
1899                              maximum->location,
1900                              8, 0);
1901                   ++e;
1902                 }
1903
1904               max_ll = ll_next (max_ll);
1905             }
1906
1907
1908           if ( fctr->indep_var[0])
1909             {
1910               struct string vstr;
1911               ds_init_empty (&vstr);
1912               var_append_value_name (fctr->indep_var[0],
1913                                      result->value[0], &vstr);
1914
1915               tab_text (tbl, 1,
1916                         heading_rows + row_var_start + row_result_start,
1917                         TAB_LEFT,
1918                         ds_cstr (&vstr)
1919                         );
1920
1921               ds_destroy (&vstr);
1922             }
1923
1924
1925           tab_text (tbl, n_cols - 4,
1926                     heading_rows + row_var_start + row_result_start,
1927                     TAB_RIGHT,
1928                     _("Highest"));
1929
1930           tab_text (tbl, n_cols - 4,
1931                     heading_rows + row_var_start + row_result_start + cmd.st_n,
1932                     TAB_RIGHT,
1933                     _("Lowest"));
1934         }
1935     }
1936
1937   tab_vline (tbl, TAL_2, heading_columns, 0, n_rows - 1);
1938
1939
1940   tab_title (tbl, _("Extreme Values"));
1941
1942
1943   tab_text (tbl, n_cols - 2, 0, TAB_CENTER | TAT_TITLE,
1944             _("Case Number"));
1945
1946
1947   tab_text (tbl, n_cols - 1, 0, TAB_CENTER | TAT_TITLE,
1948             _("Value"));
1949
1950   tab_submit (tbl);
1951 }
1952
1953 #define PERCENTILE_ROWS 2
1954
1955 static void
1956 show_percentiles (const struct variable **dependent_var,
1957                   int n_dep_var,
1958                   const struct xfactor *fctr)
1959 {
1960   int i;
1961   int v;
1962   int heading_columns = 2;
1963   int n_cols;
1964   const int n_percentiles = subc_list_double_count (&percentile_list);
1965   const int heading_rows = 2;
1966   struct tab_table *tbl;
1967
1968   int n_rows ;
1969   n_rows = n_dep_var;
1970
1971   assert (fctr);
1972
1973   if ( fctr->indep_var[0] )
1974     {
1975       heading_columns = 3;
1976
1977       if ( fctr->indep_var[1] )
1978         {
1979           heading_columns = 4;
1980         }
1981     }
1982
1983   n_rows *= ll_count (&fctr->result_list) * PERCENTILE_ROWS;
1984   n_rows += heading_rows;
1985
1986   n_cols = heading_columns + n_percentiles;
1987
1988   tbl = tab_create (n_cols, n_rows, 0);
1989   tab_headers (tbl, heading_columns, 0, heading_rows, 0);
1990
1991   tab_dim (tbl, tab_natural_dimensions);
1992
1993   /* Outline the box */
1994   tab_box (tbl,
1995            TAL_2, TAL_2,
1996            -1, -1,
1997            0, 0,
1998            n_cols - 1, n_rows - 1);
1999
2000
2001   tab_hline (tbl, TAL_2, 0, n_cols - 1, heading_rows );
2002   tab_hline (tbl, TAL_2, 1, n_cols - 1, heading_rows );
2003
2004   if ( fctr->indep_var[0])
2005     tab_text (tbl, 1, 1, TAT_TITLE, var_to_string (fctr->indep_var[0]));
2006
2007   if ( fctr->indep_var[1])
2008     tab_text (tbl, 2, 1, TAT_TITLE, var_to_string (fctr->indep_var[1]));
2009
2010   for (v = 0 ; v < n_dep_var ; ++v )
2011     {
2012       double hinges[3];
2013       struct ll *ll;
2014       int i = 0;
2015
2016       const int row_var_start =
2017         v * PERCENTILE_ROWS * ll_count(&fctr->result_list);
2018
2019       tab_text (tbl,
2020                 0,
2021                 heading_rows + row_var_start,
2022                 TAB_LEFT | TAT_TITLE,
2023                 var_to_string (dependent_var[v])
2024                 );
2025
2026       for (ll = ll_head (&fctr->result_list);
2027            ll != ll_null (&fctr->result_list); i++, ll = ll_next (ll))
2028         {
2029           int j;
2030           const struct factor_result *result =
2031             ll_data (ll, struct factor_result, ll);
2032
2033           if ( i > 0 || v > 0 )
2034             {
2035               const int left_col = (i == 0) ? 0 : 1;
2036               tab_hline (tbl, TAL_1, left_col, n_cols - 1,
2037                          heading_rows + row_var_start + i * PERCENTILE_ROWS);
2038             }
2039
2040           if ( fctr->indep_var[0])
2041             {
2042               struct string vstr;
2043               ds_init_empty (&vstr);
2044               var_append_value_name (fctr->indep_var[0],
2045                                      result->value[0], &vstr);
2046
2047               tab_text (tbl, 1,
2048                         heading_rows + row_var_start + i * PERCENTILE_ROWS,
2049                         TAB_LEFT,
2050                         ds_cstr (&vstr)
2051                         );
2052
2053               ds_destroy (&vstr);
2054             }
2055
2056
2057           tab_text (tbl, n_cols - n_percentiles - 1,
2058                     heading_rows + row_var_start + i * PERCENTILE_ROWS,
2059                     TAB_LEFT,
2060                     ptile_alg_desc [percentile_algorithm]);
2061
2062
2063           tab_text (tbl, n_cols - n_percentiles - 1,
2064                     heading_rows + row_var_start + 1 + i * PERCENTILE_ROWS,
2065                     TAB_LEFT,
2066                     _("Tukey's Hinges"));
2067
2068
2069           tab_vline (tbl, TAL_1, n_cols - n_percentiles -1, heading_rows, n_rows - 1);
2070
2071           tukey_hinges_calculate ((struct tukey_hinges *) result->metrics[v].tukey_hinges,
2072                                   hinges);
2073
2074           for (j = 0; j < n_percentiles; ++j)
2075             {
2076               double hinge = SYSMIS;
2077               tab_float (tbl, n_cols - n_percentiles + j,
2078                          heading_rows + row_var_start + i * PERCENTILE_ROWS,
2079                          TAB_CENTER,
2080                          percentile_calculate (result->metrics[v].ptl[j],
2081                                                percentile_algorithm),
2082                          8, 2
2083                          );
2084
2085               if ( result->metrics[v].ptl[j]->ptile == 0.5)
2086                 hinge = hinges[1];
2087               else if ( result->metrics[v].ptl[j]->ptile == 0.25)
2088                 hinge = hinges[0];
2089               else if ( result->metrics[v].ptl[j]->ptile == 0.75)
2090                 hinge = hinges[2];
2091
2092               if ( hinge != SYSMIS)
2093                 tab_float (tbl, n_cols - n_percentiles + j,
2094                            heading_rows + row_var_start + 1 + i * PERCENTILE_ROWS,
2095                            TAB_CENTER,
2096                            hinge,
2097                            8, 2
2098                            );
2099
2100             }
2101         }
2102     }
2103
2104   tab_vline (tbl, TAL_2, heading_columns, 0, n_rows - 1);
2105
2106   tab_title (tbl, _("Percentiles"));
2107
2108
2109   for (i = 0 ; i < n_percentiles; ++i )
2110     {
2111       tab_text (tbl, n_cols - n_percentiles + i, 1,
2112                 TAB_CENTER | TAT_TITLE | TAT_PRINTF,
2113                 _("%g"),
2114                 subc_list_double_at (&percentile_list, i)
2115                 );
2116
2117
2118     }
2119
2120   tab_joint_text (tbl,
2121                   n_cols - n_percentiles, 0,
2122                   n_cols - 1, 0,
2123                   TAB_CENTER | TAT_TITLE,
2124                   _("Percentiles"));
2125
2126   /* Vertical lines for the data only */
2127   tab_box (tbl,
2128            -1, -1,
2129            -1, TAL_1,
2130            n_cols - n_percentiles, 1,
2131            n_cols - 1, n_rows - 1);
2132
2133   tab_hline (tbl, TAL_1, n_cols - n_percentiles, n_cols - 1, 1);
2134
2135
2136   tab_submit (tbl);
2137 }
2138
2139
2140 static void
2141 factor_to_string_concise (const struct xfactor *fctr,
2142                           const struct factor_result *result,
2143                           struct string *str
2144                           )
2145 {
2146   if (fctr->indep_var[0])
2147     {
2148       var_append_value_name (fctr->indep_var[0], result->value[0], str);
2149
2150       if ( fctr->indep_var[1] )
2151         {
2152           ds_put_cstr (str, ",");
2153
2154           var_append_value_name (fctr->indep_var[1], result->value[1], str);
2155
2156           ds_put_cstr (str, ")");
2157         }
2158     }
2159 }
2160
2161
2162 static void
2163 factor_to_string (const struct xfactor *fctr,
2164                   const struct factor_result *result,
2165                   struct string *str
2166                   )
2167 {
2168   if (fctr->indep_var[0])
2169     {
2170       ds_put_format (str, "(%s = ", var_get_name (fctr->indep_var[0]));
2171
2172       var_append_value_name (fctr->indep_var[0], result->value[0], str);
2173
2174       if ( fctr->indep_var[1] )
2175         {
2176           ds_put_cstr (str, ",");
2177           ds_put_format (str, "%s = ", var_get_name (fctr->indep_var[1]));
2178
2179           var_append_value_name (fctr->indep_var[1], result->value[1], str);
2180         }
2181       ds_put_cstr (str, ")");
2182     }
2183 }
2184
2185
2186
2187
2188 /*
2189   Local Variables:
2190   mode: c
2191   End:
2192 */