pintos-os.org Git - pspp/blob - src/language/stats/examine.q

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