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/charts/box-whisker.h>
  52 #include <output/charts/np-plot.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 tukey_hinges *tukey_hinges;
 108   struct box_whisker *box_whisker;
 109   struct trimmed_mean *trimmed_mean;
 110   struct histogram *histogram;
 111   struct np *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   /* Sum of weights of non_missing values */
 126   double n_valid;
 127
 128   double mean;
 129
 130   double variance;
 131
 132   double skewness;
 133
 134   double kurtosis;
 135
 136   double se_mean;
 137
 138   struct extrema *minima;
 139   struct extrema *maxima;
 140 };
 141
 142 struct factor_result
 143 {
 144   struct ll ll;
 145
 146   union value value[2];
 147
 148   /* An array of factor metrics, one for each variable */
 149   struct factor_metrics *metrics;
 150 };
 151
 152 struct xfactor
 153 {
 154   /* We need to make a list of this structure */
 155   struct ll ll;
 156
 157   /* The independent variable */
 158   const struct variable const* indep_var[2];
 159
 160   /* A list of results for this factor */
 161   struct ll_list result_list ;
 162 };
 163
 164
 165 static void
 166 factor_destroy (struct xfactor *fctr)
 167 {
 168   struct ll *ll = ll_head (&fctr->result_list);
 169   while (ll != ll_null (&fctr->result_list))
 170     {
 171       int v;
 172       struct factor_result *result =
 173         ll_data (ll, struct factor_result, ll);
 174       int i;
 175
 176       for (v = 0; v < n_dependent_vars; ++v)
 177         {
 178           int i;
 179           moments1_destroy (result->metrics[v].moments);
 180           extrema_destroy (result->metrics[v].minima);
 181           extrema_destroy (result->metrics[v].maxima);
 182           statistic_destroy (&result->metrics[v].trimmed_mean->parent.parent);
 183           statistic_destroy (&result->metrics[v].tukey_hinges->parent.parent);
 184           statistic_destroy (&result->metrics[v].box_whisker->parent.parent);
 185           statistic_destroy (&result->metrics[v].histogram->parent);
 186           for (i = 0 ; i < result->metrics[v].n_ptiles; ++i)
 187             statistic_destroy (&result->metrics[v].ptl[i]->parent.parent);
 188           free (result->metrics[v].ptl);
 189           free (result->metrics[v].quartiles);
 190           casereader_destroy (result->metrics[v].up_reader);
 191         }
 192
 193       for (i = 0; i < 2; i++)
 194         if (fctr->indep_var[i])
 195           value_destroy (&result->value[i],
 196                          var_get_width (fctr->indep_var[i]));
 197       free (result->metrics);
 198       ll = ll_next (ll);
 199       free (result);
 200     }
 201 }
 202
 203 static struct xfactor level0_factor;
 204 static struct ll_list factor_list;
 205
 206 /* Parse the clause specifying the factors */
 207 static int examine_parse_independent_vars (struct lexer *lexer,
 208                                            const struct dictionary *dict,
 209                                            struct cmd_examine *cmd);
 210
 211 /* Output functions */
 212 static void show_summary (const struct variable **dependent_var, int n_dep_var,
 213                           const struct dictionary *dict,
 214                           const struct xfactor *f);
 215
 216
 217 static void show_descriptives (const struct variable **dependent_var,
 218                                int n_dep_var,
 219                                const struct xfactor *f);
 220
 221
 222 static void show_percentiles (const struct variable **dependent_var,
 223                                int n_dep_var,
 224                                const struct xfactor *f);
 225
 226
 227 static void show_extremes (const struct variable **dependent_var,
 228                            int n_dep_var,
 229                            const struct xfactor *f);
 230
 231
 232
 233
 234 /* Per Split function */
 235 static void run_examine (struct cmd_examine *, struct casereader *,
 236                          struct dataset *);
 237
 238 static void output_examine (const struct dictionary *dict);
 239
 240
 241 void factor_calc (const struct ccase *c, int case_no,
 242                   double weight, bool case_missing);
 243
 244
 245 /* Represent a factor as a string, so it can be
 246    printed in a human readable fashion */
 247 static void factor_to_string (const struct xfactor *fctr,
 248                               const struct factor_result *result,
 249                               struct string *str);
 250
 251 /* Represent a factor as a string, so it can be
 252    printed in a human readable fashion,
 253    but sacrificing some readablility for the sake of brevity */
 254 static void
 255 factor_to_string_concise (const struct xfactor *fctr,
 256                           const struct factor_result *result,
 257                           struct string *str
 258                           );
 259
 260
 261
 262 /* Categories of missing values to exclude. */
 263 static enum mv_class exclude_values;
 264
 265 int
 266 cmd_examine (struct lexer *lexer, struct dataset *ds)
 267 {
 268   struct casegrouper *grouper;
 269   struct casereader *group;
 270   bool ok;
 271
 272   subc_list_double_create (&percentile_list);
 273   percentile_algorithm = PC_HAVERAGE;
 274
 275   ll_init (&factor_list);
 276
 277   if ( !parse_examine (lexer, ds, &cmd, NULL) )
 278     {
 279       subc_list_double_destroy (&percentile_list);
 280       return CMD_FAILURE;
 281     }
 282
 283   /* If /MISSING=INCLUDE is set, then user missing values are ignored */
 284   exclude_values = cmd.incl == XMN_INCLUDE ? MV_SYSTEM : MV_ANY;
 285
 286   if ( cmd.st_n == SYSMIS )
 287     cmd.st_n = 5;
 288
 289   if ( ! cmd.sbc_cinterval)
 290     cmd.n_cinterval[0] = 95.0;
 291
 292   /* If descriptives have been requested, make sure the
 293      quartiles are calculated */
 294   if ( cmd.a_statistics[XMN_ST_DESCRIPTIVES] )
 295     {
 296       subc_list_double_push (&percentile_list, 25);
 297       subc_list_double_push (&percentile_list, 50);
 298       subc_list_double_push (&percentile_list, 75);
 299     }
 300
 301   grouper = casegrouper_create_splits (proc_open (ds), dataset_dict (ds));
 302
 303   while (casegrouper_get_next_group (grouper, &group))
 304     {
 305       struct casereader *reader =
 306         casereader_create_arithmetic_sequence (group, 1, 1);
 307
 308       run_examine (&cmd, reader, ds);
 309     }
 310
 311   ok = casegrouper_destroy (grouper);
 312   ok = proc_commit (ds) && ok;
 313
 314   if ( dependent_vars )
 315     free (dependent_vars);
 316
 317   subc_list_double_destroy (&percentile_list);
 318
 319   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
 320 };
 321
 322
 323
 324
 325 static void
 326 show_npplot (const struct variable **dependent_var,
 327              int n_dep_var,
 328              const struct xfactor *fctr)
 329 {
 330   int v;
 331
 332   for (v = 0; v < n_dep_var; ++v)
 333     {
 334       struct ll *ll;
 335       for (ll = ll_head (&fctr->result_list);
 336            ll != ll_null (&fctr->result_list);
 337            ll = ll_next (ll))
 338         {
 339           struct string label;
 340           const struct factor_result *result =
 341             ll_data (ll, struct factor_result, ll);
 342           struct chart *npp, *dnpp;
 343           struct casereader *reader;
 344           struct np *np;
 345
 346           ds_init_empty (&label);
 347           ds_put_format (&label, "%s ", var_get_name (dependent_var[v]));
 348           factor_to_string (fctr, result, &label);
 349
 350           np = result->metrics[v].np;
 351           reader = casewriter_make_reader (np->writer);
 352           npp = np_plot_create (np, reader, ds_cstr (&label));
 353           dnpp = dnp_plot_create (np, reader, ds_cstr (&label));
 354
 355           ds_destroy (&label);
 356
 357           if (npp == NULL || dnpp == NULL)
 358             {
 359               msg (MW, _("Not creating NP plot because data set is empty."));
 360               chart_unref (npp);
 361               chart_unref (dnpp);
 362             }
 363           else
 364             {
 365               chart_submit (npp);
 366               chart_submit (dnpp);
 367             }
 368
 369           statistic_destroy (&np->parent.parent);
 370         }
 371     }
 372 }
 373
 374
 375 static void
 376 show_histogram (const struct variable **dependent_var,
 377                 int n_dep_var,
 378                 const struct xfactor *fctr)
 379 {
 380   int v;
 381
 382   for (v = 0; v < n_dep_var; ++v)
 383     {
 384       struct ll *ll;
 385       for (ll = ll_head (&fctr->result_list);
 386            ll != ll_null (&fctr->result_list);
 387            ll = ll_next (ll))
 388         {
 389           struct string str;
 390           const struct factor_result *result =
 391             ll_data (ll, struct factor_result, ll);
 392           struct histogram *histogram;
 393           double mean, var, n;
 394
 395           histogram = result->metrics[v].histogram;
 396           if (histogram == NULL)
 397             {
 398               /* Probably all values are SYSMIS. */
 399               continue;
 400             }
 401
 402           ds_init_empty (&str);
 403           ds_put_format (&str, "%s ", var_get_name (dependent_var[v]));
 404
 405           factor_to_string (fctr, result, &str);
 406
 407           moments1_calculate (result->metrics[v].moments,
 408                               &n, &mean, &var, NULL,  NULL);
 409           chart_submit (histogram_chart_create (histogram, ds_cstr (&str),
 410                                                 n, mean, 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       chart_submit (boxplot_get_chart (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       chart_submit (boxplot_get_chart (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   tab_dim (tbl, tab_natural_dimensions, NULL, NULL);
1139
1140   /* Outline the box */
1141   tab_box (tbl,
1142            TAL_2, TAL_2,
1143            -1, -1,
1144            0, 0,
1145            n_cols - 1, n_rows - 1);
1146
1147   /* Vertical lines for the data only */
1148   tab_box (tbl,
1149            -1, -1,
1150            -1, TAL_1,
1151            heading_columns, 0,
1152            n_cols - 1, n_rows - 1);
1153
1154
1155   tab_hline (tbl, TAL_2, 0, n_cols - 1, heading_rows );
1156   tab_hline (tbl, TAL_1, heading_columns, n_cols - 1, 1 );
1157   tab_hline (tbl, TAL_1, heading_columns, n_cols - 1, heading_rows -1 );
1158
1159   tab_vline (tbl, TAL_2, heading_columns, 0, n_rows - 1);
1160
1161
1162   tab_title (tbl, _("Case Processing Summary"));
1163
1164   tab_joint_text (tbl, heading_columns, 0,
1165                   n_cols -1, 0,
1166                   TAB_CENTER | TAT_TITLE,
1167                   _("Cases"));
1168
1169   /* Remove lines ... */
1170   tab_box (tbl,
1171            -1, -1,
1172            TAL_0, TAL_0,
1173            heading_columns, 0,
1174            n_cols - 1, 0);
1175
1176   for (j = 0 ; j < 3 ; ++j)
1177     {
1178       tab_text (tbl, heading_columns + j * 2 , 2, TAB_CENTER | TAT_TITLE,
1179                 _("N"));
1180
1181       tab_text (tbl, heading_columns + j * 2 + 1, 2, TAB_CENTER | TAT_TITLE,
1182                 _("Percent"));
1183
1184       tab_joint_text (tbl, heading_columns + j * 2 , 1,
1185                       heading_columns + j * 2 + 1, 1,
1186                       TAB_CENTER | TAT_TITLE,
1187                       subtitle[j]);
1188
1189       tab_box (tbl, -1, -1,
1190                TAL_0, TAL_0,
1191                heading_columns + j * 2, 1,
1192                heading_columns + j * 2 + 1, 1);
1193     }
1194
1195
1196   /* Titles for the independent variables */
1197   if ( fctr->indep_var[0] )
1198     {
1199       tab_text (tbl, 1, heading_rows - 1, TAB_CENTER | TAT_TITLE,
1200                 var_to_string (fctr->indep_var[0]));
1201
1202       if ( fctr->indep_var[1] )
1203         {
1204           tab_text (tbl, 2, heading_rows - 1, TAB_CENTER | TAT_TITLE,
1205                     var_to_string (fctr->indep_var[1]));
1206         }
1207     }
1208
1209   for (v = 0 ; v < n_dep_var ; ++v)
1210     {
1211       int j = 0;
1212       struct ll *ll;
1213       const union value *last_value = NULL;
1214
1215       if ( v > 0 )
1216         tab_hline (tbl, TAL_1, 0, n_cols -1 ,
1217                    v * ll_count (&fctr->result_list)
1218                    + heading_rows);
1219
1220       tab_text (tbl,
1221                 0,
1222                 v * ll_count (&fctr->result_list) + heading_rows,
1223                 TAB_LEFT | TAT_TITLE,
1224                 var_to_string (dependent_var[v])
1225                 );
1226
1227
1228       for (ll = ll_head (&fctr->result_list);
1229            ll != ll_null (&fctr->result_list); ll = ll_next (ll))
1230         {
1231           double n;
1232           const struct factor_result *result =
1233             ll_data (ll, struct factor_result, ll);
1234
1235           if ( fctr->indep_var[0] )
1236             {
1237
1238               if ( last_value == NULL ||
1239                    !value_equal (last_value, &result->value[0],
1240                                  var_get_width (fctr->indep_var[0])))
1241                 {
1242                   struct string str;
1243
1244                   last_value = &result->value[0];
1245                   ds_init_empty (&str);
1246
1247                   var_append_value_name (fctr->indep_var[0], &result->value[0],
1248                                          &str);
1249
1250                   tab_text (tbl, 1,
1251                             heading_rows + j +
1252                             v * ll_count (&fctr->result_list),
1253                             TAB_LEFT | TAT_TITLE,
1254                             ds_cstr (&str));
1255
1256                   ds_destroy (&str);
1257
1258                   if ( fctr->indep_var[1] && j > 0)
1259                     tab_hline (tbl, TAL_1, 1, n_cols - 1,
1260                                heading_rows + j +
1261                                v * ll_count (&fctr->result_list));
1262                 }
1263
1264               if ( fctr->indep_var[1])
1265                 {
1266                   struct string str;
1267
1268                   ds_init_empty (&str);
1269
1270                   var_append_value_name (fctr->indep_var[1],
1271                                          &result->value[1], &str);
1272
1273                   tab_text (tbl, 2,
1274                             heading_rows + j +
1275                             v * ll_count (&fctr->result_list),
1276                             TAB_LEFT | TAT_TITLE,
1277                             ds_cstr (&str));
1278
1279                   ds_destroy (&str);
1280                 }
1281             }
1282
1283
1284           moments1_calculate (result->metrics[v].moments,
1285                               &n, &result->metrics[v].mean,
1286                               &result->metrics[v].variance,
1287                               &result->metrics[v].skewness,
1288                               &result->metrics[v].kurtosis);
1289
1290           result->metrics[v].se_mean = sqrt (result->metrics[v].variance / n) ;
1291
1292           /* Total Valid */
1293           tab_double (tbl, heading_columns,
1294                      heading_rows + j + v * ll_count (&fctr->result_list),
1295                      TAB_LEFT,
1296                      n, wfmt);
1297
1298           tab_text_format (tbl, heading_columns + 1,
1299                            heading_rows + j + v * ll_count (&fctr->result_list),
1300                            TAB_RIGHT,
1301                            "%g%%", n * 100.0 / result->metrics[v].n);
1302
1303           /* Total Missing */
1304           tab_double (tbl, heading_columns + 2,
1305                      heading_rows + j + v * ll_count (&fctr->result_list),
1306                      TAB_LEFT,
1307                      result->metrics[v].n - n,
1308                      wfmt);
1309
1310           tab_text_format (tbl, heading_columns + 3,
1311                            heading_rows + j + v * ll_count (&fctr->result_list),
1312                            TAB_RIGHT,
1313                            "%g%%",
1314                            (result->metrics[v].n - n) * 100.0 / result->metrics[v].n
1315                            );
1316
1317           /* Total Valid + Missing */
1318           tab_double (tbl, heading_columns + 4,
1319                      heading_rows + j + v * ll_count (&fctr->result_list),
1320                      TAB_LEFT,
1321                      result->metrics[v].n,
1322                      wfmt);
1323
1324           tab_text_format (tbl, heading_columns + 5,
1325                            heading_rows + j + v * ll_count (&fctr->result_list),
1326                            TAB_RIGHT,
1327                            "%g%%",
1328                            ((result->metrics[v].n) * 100.0
1329                             / result->metrics[v].n));
1330
1331           ++j;
1332         }
1333     }
1334
1335
1336   tab_submit (tbl);
1337 }
1338
1339 #define DESCRIPTIVE_ROWS 13
1340
1341 static void
1342 show_descriptives (const struct variable **dependent_var,
1343                    int n_dep_var,
1344                    const struct xfactor *fctr)
1345 {
1346   int v;
1347   int heading_columns = 3;
1348   int n_cols;
1349   const int heading_rows = 1;
1350   struct tab_table *tbl;
1351
1352   int n_rows ;
1353   n_rows = n_dep_var;
1354
1355   assert (fctr);
1356
1357   if ( fctr->indep_var[0] )
1358     {
1359       heading_columns = 4;
1360
1361       if ( fctr->indep_var[1] )
1362         {
1363           heading_columns = 5;
1364         }
1365     }
1366
1367   n_rows *= ll_count (&fctr->result_list) * DESCRIPTIVE_ROWS;
1368   n_rows += heading_rows;
1369
1370   n_cols = heading_columns + 2;
1371
1372   tbl = tab_create (n_cols, n_rows);
1373   tab_headers (tbl, heading_columns, 0, heading_rows, 0);
1374
1375   tab_dim (tbl, tab_natural_dimensions, NULL, NULL);
1376
1377   /* Outline the box */
1378   tab_box (tbl,
1379            TAL_2, TAL_2,
1380            -1, -1,
1381            0, 0,
1382            n_cols - 1, n_rows - 1);
1383
1384
1385   tab_hline (tbl, TAL_2, 0, n_cols - 1, heading_rows );
1386   tab_hline (tbl, TAL_2, 1, n_cols - 1, heading_rows );
1387
1388   tab_vline (tbl, TAL_1, n_cols - 1, 0, n_rows - 1);
1389
1390
1391   if ( fctr->indep_var[0])
1392     tab_text (tbl, 1, 0, TAT_TITLE, var_to_string (fctr->indep_var[0]));
1393
1394   if ( fctr->indep_var[1])
1395     tab_text (tbl, 2, 0, TAT_TITLE, var_to_string (fctr->indep_var[1]));
1396
1397   for (v = 0 ; v < n_dep_var ; ++v )
1398     {
1399       struct ll *ll;
1400       int i = 0;
1401
1402       const int row_var_start =
1403         v * DESCRIPTIVE_ROWS * ll_count(&fctr->result_list);
1404
1405       tab_text (tbl,
1406                 0,
1407                 heading_rows + row_var_start,
1408                 TAB_LEFT | TAT_TITLE,
1409                 var_to_string (dependent_var[v])
1410                 );
1411
1412       for (ll = ll_head (&fctr->result_list);
1413            ll != ll_null (&fctr->result_list); i++, ll = ll_next (ll))
1414         {
1415           const struct factor_result *result =
1416             ll_data (ll, struct factor_result, ll);
1417
1418           const double t =
1419             gsl_cdf_tdist_Qinv ((1 - cmd.n_cinterval[0] / 100.0) / 2.0,
1420                                       result->metrics[v].n - 1);
1421
1422           if ( i > 0 || v > 0 )
1423             {
1424               const int left_col = (i == 0) ? 0 : 1;
1425               tab_hline (tbl, TAL_1, left_col, n_cols - 1,
1426                          heading_rows + row_var_start + i * DESCRIPTIVE_ROWS);
1427             }
1428
1429           if ( fctr->indep_var[0])
1430             {
1431               struct string vstr;
1432               ds_init_empty (&vstr);
1433               var_append_value_name (fctr->indep_var[0],
1434                                      &result->value[0], &vstr);
1435
1436               tab_text (tbl, 1,
1437                         heading_rows + row_var_start + i * DESCRIPTIVE_ROWS,
1438                         TAB_LEFT,
1439                         ds_cstr (&vstr)
1440                         );
1441
1442               ds_destroy (&vstr);
1443             }
1444
1445
1446           tab_text (tbl, n_cols - 4,
1447                     heading_rows + row_var_start + i * DESCRIPTIVE_ROWS,
1448                     TAB_LEFT,
1449                     _("Mean"));
1450
1451           tab_text_format (tbl, n_cols - 4,
1452                            heading_rows + row_var_start + 1 + i * DESCRIPTIVE_ROWS,
1453                            TAB_LEFT,
1454                            _("%g%% Confidence Interval for Mean"),
1455                            cmd.n_cinterval[0]);
1456
1457           tab_text (tbl, n_cols - 3,
1458                     heading_rows + row_var_start + 1 + i * DESCRIPTIVE_ROWS,
1459                     TAB_LEFT,
1460                     _("Lower Bound"));
1461
1462           tab_text (tbl, n_cols - 3,
1463                     heading_rows + row_var_start + 2 + i * DESCRIPTIVE_ROWS,
1464                     TAB_LEFT,
1465                     _("Upper Bound"));
1466
1467           tab_text (tbl, n_cols - 4,
1468                     heading_rows + row_var_start + 3 + i * DESCRIPTIVE_ROWS,
1469                     TAB_LEFT, _("5% Trimmed Mean"));
1470
1471           tab_text (tbl, n_cols - 4,
1472                     heading_rows + row_var_start + 4 + i * DESCRIPTIVE_ROWS,
1473                     TAB_LEFT,
1474                     _("Median"));
1475
1476           tab_text (tbl, n_cols - 4,
1477                     heading_rows + row_var_start + 5 + i * DESCRIPTIVE_ROWS,
1478                     TAB_LEFT,
1479                     _("Variance"));
1480
1481           tab_text (tbl, n_cols - 4,
1482                     heading_rows + row_var_start + 6 + i * DESCRIPTIVE_ROWS,
1483                     TAB_LEFT,
1484                     _("Std. Deviation"));
1485
1486           tab_text (tbl, n_cols - 4,
1487                     heading_rows + row_var_start + 7 + i * DESCRIPTIVE_ROWS,
1488                     TAB_LEFT,
1489                     _("Minimum"));
1490
1491           tab_text (tbl, n_cols - 4,
1492                     heading_rows + row_var_start + 8 + i * DESCRIPTIVE_ROWS,
1493                     TAB_LEFT,
1494                     _("Maximum"));
1495
1496           tab_text (tbl, n_cols - 4,
1497                     heading_rows + row_var_start + 9 + i * DESCRIPTIVE_ROWS,
1498                     TAB_LEFT,
1499                     _("Range"));
1500
1501           tab_text (tbl, n_cols - 4,
1502                     heading_rows + row_var_start + 10 + i * DESCRIPTIVE_ROWS,
1503                     TAB_LEFT,
1504                     _("Interquartile Range"));
1505
1506
1507           tab_text (tbl, n_cols - 4,
1508                     heading_rows + row_var_start + 11 + i * DESCRIPTIVE_ROWS,
1509                     TAB_LEFT,
1510                     _("Skewness"));
1511
1512           tab_text (tbl, n_cols - 4,
1513                     heading_rows + row_var_start + 12 + i * DESCRIPTIVE_ROWS,
1514                     TAB_LEFT,
1515                     _("Kurtosis"));
1516
1517
1518           /* Now the statistics ... */
1519
1520           tab_double (tbl, n_cols - 2,
1521                     heading_rows + row_var_start + i * DESCRIPTIVE_ROWS,
1522                      TAB_CENTER,
1523                      result->metrics[v].mean,
1524                      NULL);
1525
1526           tab_double (tbl, n_cols - 1,
1527                     heading_rows + row_var_start + i * DESCRIPTIVE_ROWS,
1528                      TAB_CENTER,
1529                      result->metrics[v].se_mean,
1530                      NULL);
1531
1532
1533           tab_double (tbl, n_cols - 2,
1534                      heading_rows + row_var_start + 1 + i * DESCRIPTIVE_ROWS,
1535                      TAB_CENTER,
1536                      result->metrics[v].mean - t *
1537                       result->metrics[v].se_mean,
1538                      NULL);
1539
1540           tab_double (tbl, n_cols - 2,
1541                      heading_rows + row_var_start + 2 + i * DESCRIPTIVE_ROWS,
1542                      TAB_CENTER,
1543                      result->metrics[v].mean + t *
1544                       result->metrics[v].se_mean,
1545                      NULL);
1546
1547
1548           tab_double (tbl, n_cols - 2,
1549                      heading_rows + row_var_start + 3 + i * DESCRIPTIVE_ROWS,
1550                      TAB_CENTER,
1551                      trimmed_mean_calculate (result->metrics[v].trimmed_mean),
1552                      NULL);
1553
1554
1555           tab_double (tbl, n_cols - 2,
1556                      heading_rows + row_var_start + 4 + i * DESCRIPTIVE_ROWS,
1557                      TAB_CENTER,
1558                      percentile_calculate (result->metrics[v].quartiles[1], percentile_algorithm),
1559                      NULL);
1560
1561
1562           tab_double (tbl, n_cols - 2,
1563                      heading_rows + row_var_start + 5 + i * DESCRIPTIVE_ROWS,
1564                      TAB_CENTER,
1565                      result->metrics[v].variance,
1566                      NULL);
1567
1568           tab_double (tbl, n_cols - 2,
1569                      heading_rows + row_var_start + 6 + i * DESCRIPTIVE_ROWS,
1570                      TAB_CENTER,
1571                      sqrt (result->metrics[v].variance),
1572                      NULL);
1573
1574           tab_double (tbl, n_cols - 2,
1575                      heading_rows + row_var_start + 10 + i * DESCRIPTIVE_ROWS,
1576                      TAB_CENTER,
1577                      percentile_calculate (result->metrics[v].quartiles[2],
1578                                            percentile_algorithm) -
1579                      percentile_calculate (result->metrics[v].quartiles[0],
1580                                            percentile_algorithm),
1581                      NULL);
1582
1583
1584           tab_double (tbl, n_cols - 2,
1585                      heading_rows + row_var_start + 11 + i * DESCRIPTIVE_ROWS,
1586                      TAB_CENTER,
1587                      result->metrics[v].skewness,
1588                      NULL);
1589
1590           tab_double (tbl, n_cols - 2,
1591                      heading_rows + row_var_start + 12 + i * DESCRIPTIVE_ROWS,
1592                      TAB_CENTER,
1593                      result->metrics[v].kurtosis,
1594                      NULL);
1595
1596           tab_double (tbl, n_cols - 1,
1597                      heading_rows + row_var_start + 11 + i * DESCRIPTIVE_ROWS,
1598                      TAB_CENTER,
1599                      calc_seskew (result->metrics[v].n),
1600                      NULL);
1601
1602           tab_double (tbl, n_cols - 1,
1603                      heading_rows + row_var_start + 12 + i * DESCRIPTIVE_ROWS,
1604                      TAB_CENTER,
1605                      calc_sekurt (result->metrics[v].n),
1606                      NULL);
1607
1608           {
1609             struct extremum *minimum, *maximum ;
1610
1611             struct ll *max_ll = ll_head (extrema_list (result->metrics[v].maxima));
1612             struct ll *min_ll = ll_head (extrema_list (result->metrics[v].minima));
1613
1614             maximum = ll_data (max_ll, struct extremum, ll);
1615             minimum = ll_data (min_ll, struct extremum, ll);
1616
1617             tab_double (tbl, n_cols - 2,
1618                        heading_rows + row_var_start + 7 + i * DESCRIPTIVE_ROWS,
1619                        TAB_CENTER,
1620                        minimum->value,
1621                        NULL);
1622
1623             tab_double (tbl, n_cols - 2,
1624                        heading_rows + row_var_start + 8 + i * DESCRIPTIVE_ROWS,
1625                        TAB_CENTER,
1626                        maximum->value,
1627                        NULL);
1628
1629             tab_double (tbl, n_cols - 2,
1630                        heading_rows + row_var_start + 9 + i * DESCRIPTIVE_ROWS,
1631                        TAB_CENTER,
1632                        maximum->value - minimum->value,
1633                        NULL);
1634           }
1635         }
1636     }
1637
1638   tab_vline (tbl, TAL_2, heading_columns, 0, n_rows - 1);
1639
1640   tab_title (tbl, _("Descriptives"));
1641
1642   tab_text (tbl, n_cols - 2, 0, TAB_CENTER | TAT_TITLE,
1643             _("Statistic"));
1644
1645   tab_text (tbl, n_cols - 1, 0, TAB_CENTER | TAT_TITLE,
1646             _("Std. Error"));
1647
1648   tab_submit (tbl);
1649 }
1650
1651
1652
1653 static void
1654 show_extremes (const struct variable **dependent_var,
1655                int n_dep_var,
1656                const struct xfactor *fctr)
1657 {
1658   int v;
1659   int heading_columns = 3;
1660   int n_cols;
1661   const int heading_rows = 1;
1662   struct tab_table *tbl;
1663
1664   int n_rows ;
1665   n_rows = n_dep_var;
1666
1667   assert (fctr);
1668
1669   if ( fctr->indep_var[0] )
1670     {
1671       heading_columns = 4;
1672
1673       if ( fctr->indep_var[1] )
1674         {
1675           heading_columns = 5;
1676         }
1677     }
1678
1679   n_rows *= ll_count (&fctr->result_list) * cmd.st_n * 2;
1680   n_rows += heading_rows;
1681
1682   n_cols = heading_columns + 2;
1683
1684   tbl = tab_create (n_cols, n_rows);
1685   tab_headers (tbl, heading_columns, 0, heading_rows, 0);
1686
1687   tab_dim (tbl, tab_natural_dimensions, NULL, NULL);
1688
1689   /* Outline the box */
1690   tab_box (tbl,
1691            TAL_2, TAL_2,
1692            -1, -1,
1693            0, 0,
1694            n_cols - 1, n_rows - 1);
1695
1696
1697   tab_hline (tbl, TAL_2, 0, n_cols - 1, heading_rows );
1698   tab_hline (tbl, TAL_2, 1, n_cols - 1, heading_rows );
1699   tab_vline (tbl, TAL_1, n_cols - 1, 0, n_rows - 1);
1700
1701   if ( fctr->indep_var[0])
1702     tab_text (tbl, 1, 0, TAT_TITLE, var_to_string (fctr->indep_var[0]));
1703
1704   if ( fctr->indep_var[1])
1705     tab_text (tbl, 2, 0, TAT_TITLE, var_to_string (fctr->indep_var[1]));
1706
1707   for (v = 0 ; v < n_dep_var ; ++v )
1708     {
1709       struct ll *ll;
1710       int i = 0;
1711       const int row_var_start = v * cmd.st_n * 2 * ll_count(&fctr->result_list);
1712
1713       tab_text (tbl,
1714                 0,
1715                 heading_rows + row_var_start,
1716                 TAB_LEFT | TAT_TITLE,
1717                 var_to_string (dependent_var[v])
1718                 );
1719
1720       for (ll = ll_head (&fctr->result_list);
1721            ll != ll_null (&fctr->result_list); i++, ll = ll_next (ll))
1722         {
1723           int e ;
1724           struct ll *min_ll;
1725           struct ll *max_ll;
1726           const int row_result_start = i * cmd.st_n * 2;
1727
1728           const struct factor_result *result =
1729             ll_data (ll, struct factor_result, ll);
1730
1731           if (i > 0 || v > 0)
1732             tab_hline (tbl, TAL_1, 1, n_cols - 1,
1733                        heading_rows + row_var_start + row_result_start);
1734
1735           tab_hline (tbl, TAL_1, heading_columns - 2, n_cols - 1,
1736                      heading_rows + row_var_start + row_result_start + cmd.st_n);
1737
1738           for ( e = 1; e <= cmd.st_n; ++e )
1739             {
1740               tab_text_format (tbl, n_cols - 3,
1741                                heading_rows + row_var_start + row_result_start + e - 1,
1742                                TAB_RIGHT,
1743                                "%d", e);
1744
1745               tab_text_format (tbl, n_cols - 3,
1746                                heading_rows + row_var_start + row_result_start + cmd.st_n + e - 1,
1747                                TAB_RIGHT,
1748                                "%d", e);
1749             }
1750
1751
1752           min_ll = ll_head (extrema_list (result->metrics[v].minima));
1753           for (e = 0; e < cmd.st_n;)
1754             {
1755               struct extremum *minimum = ll_data (min_ll, struct extremum, ll);
1756               double weight = minimum->weight;
1757
1758               while (weight-- > 0 && e < cmd.st_n)
1759                 {
1760                   tab_double (tbl, n_cols - 1,
1761                              heading_rows + row_var_start + row_result_start + cmd.st_n + e,
1762                              TAB_RIGHT,
1763                              minimum->value,
1764                              NULL);
1765
1766
1767                   tab_fixed (tbl, n_cols - 2,
1768                              heading_rows + row_var_start +
1769                              row_result_start + cmd.st_n + e,
1770                              TAB_RIGHT,
1771                              minimum->location,
1772                              10, 0);
1773                   ++e;
1774                 }
1775
1776               min_ll = ll_next (min_ll);
1777             }
1778
1779           max_ll = ll_head (extrema_list (result->metrics[v].maxima));
1780           for (e = 0; e < cmd.st_n;)
1781             {
1782               struct extremum *maximum = ll_data (max_ll, struct extremum, ll);
1783               double weight = maximum->weight;
1784
1785               while (weight-- > 0 && e < cmd.st_n)
1786                 {
1787                   tab_double (tbl, n_cols - 1,
1788                              heading_rows + row_var_start +
1789                               row_result_start + e,
1790                              TAB_RIGHT,
1791                              maximum->value,
1792                              NULL);
1793
1794
1795                   tab_fixed (tbl, n_cols - 2,
1796                              heading_rows + row_var_start +
1797                              row_result_start + e,
1798                              TAB_RIGHT,
1799                              maximum->location,
1800                              10, 0);
1801                   ++e;
1802                 }
1803
1804               max_ll = ll_next (max_ll);
1805             }
1806
1807
1808           if ( fctr->indep_var[0])
1809             {
1810               struct string vstr;
1811               ds_init_empty (&vstr);
1812               var_append_value_name (fctr->indep_var[0],
1813                                      &result->value[0], &vstr);
1814
1815               tab_text (tbl, 1,
1816                         heading_rows + row_var_start + row_result_start,
1817                         TAB_LEFT,
1818                         ds_cstr (&vstr)
1819                         );
1820
1821               ds_destroy (&vstr);
1822             }
1823
1824
1825           tab_text (tbl, n_cols - 4,
1826                     heading_rows + row_var_start + row_result_start,
1827                     TAB_RIGHT,
1828                     _("Highest"));
1829
1830           tab_text (tbl, n_cols - 4,
1831                     heading_rows + row_var_start + row_result_start + cmd.st_n,
1832                     TAB_RIGHT,
1833                     _("Lowest"));
1834         }
1835     }
1836
1837   tab_vline (tbl, TAL_2, heading_columns, 0, n_rows - 1);
1838
1839
1840   tab_title (tbl, _("Extreme Values"));
1841
1842
1843   tab_text (tbl, n_cols - 2, 0, TAB_CENTER | TAT_TITLE,
1844             _("Case Number"));
1845
1846
1847   tab_text (tbl, n_cols - 1, 0, TAB_CENTER | TAT_TITLE,
1848             _("Value"));
1849
1850   tab_submit (tbl);
1851 }
1852
1853 #define PERCENTILE_ROWS 2
1854
1855 static void
1856 show_percentiles (const struct variable **dependent_var,
1857                   int n_dep_var,
1858                   const struct xfactor *fctr)
1859 {
1860   int i;
1861   int v;
1862   int heading_columns = 2;
1863   int n_cols;
1864   const int n_percentiles = subc_list_double_count (&percentile_list);
1865   const int heading_rows = 2;
1866   struct tab_table *tbl;
1867
1868   int n_rows ;
1869   n_rows = n_dep_var;
1870
1871   assert (fctr);
1872
1873   if ( fctr->indep_var[0] )
1874     {
1875       heading_columns = 3;
1876
1877       if ( fctr->indep_var[1] )
1878         {
1879           heading_columns = 4;
1880         }
1881     }
1882
1883   n_rows *= ll_count (&fctr->result_list) * PERCENTILE_ROWS;
1884   n_rows += heading_rows;
1885
1886   n_cols = heading_columns + n_percentiles;
1887
1888   tbl = tab_create (n_cols, n_rows);
1889   tab_headers (tbl, heading_columns, 0, heading_rows, 0);
1890
1891   tab_dim (tbl, tab_natural_dimensions, NULL, NULL);
1892
1893   /* Outline the box */
1894   tab_box (tbl,
1895            TAL_2, TAL_2,
1896            -1, -1,
1897            0, 0,
1898            n_cols - 1, n_rows - 1);
1899
1900
1901   tab_hline (tbl, TAL_2, 0, n_cols - 1, heading_rows );
1902   tab_hline (tbl, TAL_2, 1, n_cols - 1, heading_rows );
1903
1904   if ( fctr->indep_var[0])
1905     tab_text (tbl, 1, 1, TAT_TITLE, var_to_string (fctr->indep_var[0]));
1906
1907   if ( fctr->indep_var[1])
1908     tab_text (tbl, 2, 1, TAT_TITLE, var_to_string (fctr->indep_var[1]));
1909
1910   for (v = 0 ; v < n_dep_var ; ++v )
1911     {
1912       double hinges[3];
1913       struct ll *ll;
1914       int i = 0;
1915
1916       const int row_var_start =
1917         v * PERCENTILE_ROWS * ll_count(&fctr->result_list);
1918
1919       tab_text (tbl,
1920                 0,
1921                 heading_rows + row_var_start,
1922                 TAB_LEFT | TAT_TITLE,
1923                 var_to_string (dependent_var[v])
1924                 );
1925
1926       for (ll = ll_head (&fctr->result_list);
1927            ll != ll_null (&fctr->result_list); i++, ll = ll_next (ll))
1928         {
1929           int j;
1930           const struct factor_result *result =
1931             ll_data (ll, struct factor_result, ll);
1932
1933           if ( i > 0 || v > 0 )
1934             {
1935               const int left_col = (i == 0) ? 0 : 1;
1936               tab_hline (tbl, TAL_1, left_col, n_cols - 1,
1937                          heading_rows + row_var_start + i * PERCENTILE_ROWS);
1938             }
1939
1940           if ( fctr->indep_var[0])
1941             {
1942               struct string vstr;
1943               ds_init_empty (&vstr);
1944               var_append_value_name (fctr->indep_var[0],
1945                                      &result->value[0], &vstr);
1946
1947               tab_text (tbl, 1,
1948                         heading_rows + row_var_start + i * PERCENTILE_ROWS,
1949                         TAB_LEFT,
1950                         ds_cstr (&vstr)
1951                         );
1952
1953               ds_destroy (&vstr);
1954             }
1955
1956
1957           tab_text (tbl, n_cols - n_percentiles - 1,
1958                     heading_rows + row_var_start + i * PERCENTILE_ROWS,
1959                     TAB_LEFT,
1960                     ptile_alg_desc [percentile_algorithm]);
1961
1962
1963           tab_text (tbl, n_cols - n_percentiles - 1,
1964                     heading_rows + row_var_start + 1 + i * PERCENTILE_ROWS,
1965                     TAB_LEFT,
1966                     _("Tukey's Hinges"));
1967
1968
1969           tab_vline (tbl, TAL_1, n_cols - n_percentiles -1, heading_rows, n_rows - 1);
1970
1971           tukey_hinges_calculate (result->metrics[v].tukey_hinges, hinges);
1972
1973           for (j = 0; j < n_percentiles; ++j)
1974             {
1975               double hinge = SYSMIS;
1976               tab_double (tbl, n_cols - n_percentiles + j,
1977                          heading_rows + row_var_start + i * PERCENTILE_ROWS,
1978                          TAB_CENTER,
1979                          percentile_calculate (result->metrics[v].ptl[j],
1980                                                percentile_algorithm),
1981                          NULL
1982                          );
1983
1984               if ( result->metrics[v].ptl[j]->ptile == 0.5)
1985                 hinge = hinges[1];
1986               else if ( result->metrics[v].ptl[j]->ptile == 0.25)
1987                 hinge = hinges[0];
1988               else if ( result->metrics[v].ptl[j]->ptile == 0.75)
1989                 hinge = hinges[2];
1990
1991               if ( hinge != SYSMIS)
1992                 tab_double (tbl, n_cols - n_percentiles + j,
1993                            heading_rows + row_var_start + 1 + i * PERCENTILE_ROWS,
1994                            TAB_CENTER,
1995                            hinge,
1996                            NULL
1997                            );
1998
1999             }
2000         }
2001     }
2002
2003   tab_vline (tbl, TAL_2, heading_columns, 0, n_rows - 1);
2004
2005   tab_title (tbl, _("Percentiles"));
2006
2007
2008   for (i = 0 ; i < n_percentiles; ++i )
2009     {
2010       tab_text_format (tbl, n_cols - n_percentiles + i, 1,
2011                        TAB_CENTER | TAT_TITLE,
2012                        _("%g"),
2013                        subc_list_double_at (&percentile_list, i));
2014
2015
2016     }
2017
2018   tab_joint_text (tbl,
2019                   n_cols - n_percentiles, 0,
2020                   n_cols - 1, 0,
2021                   TAB_CENTER | TAT_TITLE,
2022                   _("Percentiles"));
2023
2024   /* Vertical lines for the data only */
2025   tab_box (tbl,
2026            -1, -1,
2027            -1, TAL_1,
2028            n_cols - n_percentiles, 1,
2029            n_cols - 1, n_rows - 1);
2030
2031   tab_hline (tbl, TAL_1, n_cols - n_percentiles, n_cols - 1, 1);
2032
2033
2034   tab_submit (tbl);
2035 }
2036
2037
2038 static void
2039 factor_to_string_concise (const struct xfactor *fctr,
2040                           const struct factor_result *result,
2041                           struct string *str
2042                           )
2043 {
2044   if (fctr->indep_var[0])
2045     {
2046       var_append_value_name (fctr->indep_var[0], &result->value[0], str);
2047
2048       if ( fctr->indep_var[1] )
2049         {
2050           ds_put_cstr (str, ",");
2051
2052           var_append_value_name (fctr->indep_var[1], &result->value[1], str);
2053
2054           ds_put_cstr (str, ")");
2055         }
2056     }
2057 }
2058
2059
2060 static void
2061 factor_to_string (const struct xfactor *fctr,
2062                   const struct factor_result *result,
2063                   struct string *str
2064                   )
2065 {
2066   if (fctr->indep_var[0])
2067     {
2068       ds_put_format (str, "(%s = ", var_get_name (fctr->indep_var[0]));
2069
2070       var_append_value_name (fctr->indep_var[0], &result->value[0], str);
2071
2072       if ( fctr->indep_var[1] )
2073         {
2074           ds_put_cstr (str, ",");
2075           ds_put_format (str, "%s = ", var_get_name (fctr->indep_var[1]));
2076
2077           var_append_value_name (fctr->indep_var[1], &result->value[1], str);
2078         }
2079       ds_put_cstr (str, ")");
2080     }
2081 }
2082
2083
2084
2085
2086 /*
2087   Local Variables:
2088   mode: c
2089   End:
2090 */