src/language/stats/npar.q

   1 /* PSPP - a program for statistical analysis. -*-c-*-
   2    Copyright (C) 2006, 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 <language/stats/npar.h>
  20
  21 #include <math.h>
  22
  23 #include <data/case.h>
  24 #include <data/casegrouper.h>
  25 #include <data/casereader.h>
  26 #include <data/dictionary.h>
  27 #include <data/procedure.h>
  28 #include <language/command.h>
  29 #include <language/lexer/lexer.h>
  30 #include <language/lexer/variable-parser.h>
  31 #include <language/stats/binomial.h>
  32 #include <language/stats/chisquare.h>
  33 #include <language/stats/wilcoxon.h>
  34 #include <language/stats/sign.h>
  35 #include <libpspp/hash.h>
  36 #include <libpspp/pool.h>
  37 #include <libpspp/taint.h>
  38 #include <math/moments.h>
  39
  40 #include "npar-summary.h"
  41
  42 #include "gettext.h"
  43 #define _(msgid) gettext (msgid)
  44
  45 /* (headers) */
  46
  47 /* (specification)
  48    "NPAR TESTS" (npar_):
  49    +chisquare=custom;
  50    +binomial=custom;
  51    +wilcoxon=custom;
  52    +mcnemar=custom;
  53    +sign=custom;
  54    +cochran=varlist;
  55    +friedman=varlist;
  56    +kendall=varlist;
  57    missing=miss:!analysis/listwise,
  58    incl:include/!exclude;
  59    method=custom;
  60    +statistics[st_]=descriptives,quartiles,all.
  61 */
  62 /* (declarations) */
  63 /* (functions) */
  64
  65
  66 static struct cmd_npar_tests cmd;
  67
  68
  69 struct npar_specs
  70 {
  71   struct pool *pool;
  72   struct npar_test **test;
  73   size_t n_tests;
  74
  75   const struct variable ** vv; /* Compendium of all variables
  76                                   (those mentioned on ANY subcommand */
  77   int n_vars; /* Number of variables in vv */
  78
  79   enum mv_class filter;    /* Missing values to filter. */
  80
  81   bool descriptives;       /* Descriptive statistics should be calculated */
  82   bool quartiles;          /* Quartiles should be calculated */
  83
  84   bool exact;  /* Whether exact calculations have been requested */
  85   double timer;   /* Maximum time (in minutes) to wait for exact calculations */
  86 };
  87
  88 static void one_sample_insert_variables (const struct npar_test *test,
  89                                          struct const_hsh_table *variables);
  90
  91 static void two_sample_insert_variables (const struct npar_test *test,
  92                                          struct const_hsh_table *variables);
  93
  94
  95
  96 static void
  97 npar_execute(struct casereader *input,
  98              const struct npar_specs *specs,
  99              const struct dataset *ds)
 100 {
 101   int t;
 102   struct descriptives *summary_descriptives = NULL;
 103
 104   for ( t = 0 ; t < specs->n_tests; ++t )
 105     {
 106       const struct npar_test *test = specs->test[t];
 107       if ( NULL == test->execute )
 108         {
 109           msg (SW, _("NPAR subcommand not currently implemented."));
 110           continue;
 111         }
 112       test->execute (ds, casereader_clone (input), specs->filter, test, specs->exact, specs->timer);
 113     }
 114
 115   if ( specs->descriptives )
 116     {
 117       summary_descriptives = xnmalloc (sizeof (*summary_descriptives),
 118                                        specs->n_vars);
 119
 120       npar_summary_calc_descriptives (summary_descriptives,
 121                                       casereader_clone (input),
 122                                       dataset_dict (ds),
 123                                       specs->vv, specs->n_vars,
 124                                       specs->filter);
 125     }
 126
 127   if ( (specs->descriptives || specs->quartiles)
 128        && !taint_has_tainted_successor (casereader_get_taint (input)) )
 129     do_summary_box (summary_descriptives, specs->vv, specs->n_vars );
 130
 131   free (summary_descriptives);
 132   casereader_destroy (input);
 133 }
 134
 135 int
 136 cmd_npar_tests (struct lexer *lexer, struct dataset *ds)
 137 {
 138   bool ok;
 139   int i;
 140   struct npar_specs npar_specs = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
 141   struct const_hsh_table *var_hash;
 142   struct casegrouper *grouper;
 143   struct casereader *input, *group;
 144
 145   npar_specs.pool = pool_create ();
 146
 147   var_hash = const_hsh_create_pool (npar_specs.pool, 0,
 148                                     compare_vars_by_name, hash_var_by_name,
 149                                     NULL, NULL);
 150
 151   if ( ! parse_npar_tests (lexer, ds, &cmd, &npar_specs) )
 152     {
 153       pool_destroy (npar_specs.pool);
 154       return CMD_FAILURE;
 155     }
 156
 157   for (i = 0; i < npar_specs.n_tests; ++i )
 158     {
 159       const struct npar_test *test = npar_specs.test[i];
 160       test->insert_variables (test, var_hash);
 161     }
 162
 163   npar_specs.vv = (const struct variable **) const_hsh_sort (var_hash);
 164   npar_specs.n_vars = const_hsh_count (var_hash);
 165
 166   if ( cmd.sbc_statistics )
 167     {
 168       int i;
 169
 170       for ( i = 0 ; i < NPAR_ST_count; ++i )
 171         {
 172           if ( cmd.a_statistics[i] )
 173             {
 174               switch ( i )
 175                 {
 176                 case NPAR_ST_DESCRIPTIVES:
 177                   npar_specs.descriptives = true;
 178                   break;
 179                 case NPAR_ST_QUARTILES:
 180                   npar_specs.quartiles = true;
 181                   break;
 182                 case NPAR_ST_ALL:
 183                   npar_specs.quartiles = true;
 184                   npar_specs.descriptives = true;
 185                   break;
 186                 default:
 187                   NOT_REACHED();
 188                 };
 189             }
 190         }
 191     }
 192
 193   npar_specs.filter = cmd.incl == NPAR_EXCLUDE ? MV_ANY : MV_SYSTEM;
 194
 195   input = proc_open (ds);
 196   if ( cmd.miss == NPAR_LISTWISE )
 197     {
 198       input = casereader_create_filter_missing (input,
 199                                                 npar_specs.vv,
 200                                                 npar_specs.n_vars,
 201                                                 npar_specs.filter,
 202                                                 NULL, NULL);
 203     }
 204
 205
 206   grouper = casegrouper_create_splits (input, dataset_dict (ds));
 207   while (casegrouper_get_next_group (grouper, &group))
 208     npar_execute (group, &npar_specs, ds);
 209   ok = casegrouper_destroy (grouper);
 210   ok = proc_commit (ds) && ok;
 211
 212   const_hsh_destroy (var_hash);
 213
 214   pool_destroy (npar_specs.pool);
 215
 216   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
 217 }
 218
 219 int
 220 npar_custom_chisquare (struct lexer *lexer, struct dataset *ds,
 221                        struct cmd_npar_tests *cmd UNUSED, void *aux )
 222 {
 223   struct npar_specs *specs = aux;
 224
 225   struct chisquare_test *cstp = pool_alloc(specs->pool, sizeof(*cstp));
 226   struct one_sample_test *tp = (struct one_sample_test *) cstp;
 227
 228   ((struct npar_test *)tp)->execute = chisquare_execute;
 229   ((struct npar_test *)tp)->insert_variables = one_sample_insert_variables;
 230
 231   if (!parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
 232                                    &tp->vars, &tp->n_vars,
 233                                    PV_NO_SCRATCH | PV_NO_DUPLICATE))
 234     {
 235       return 2;
 236     }
 237
 238   cstp->ranged = false;
 239
 240   if ( lex_match (lexer, '('))
 241     {
 242       cstp->ranged = true;
 243       if ( ! lex_force_num (lexer)) return 0;
 244       cstp->lo = lex_integer (lexer);
 245       lex_get (lexer);
 246       lex_force_match (lexer, ',');
 247       if (! lex_force_num (lexer) ) return 0;
 248       cstp->hi = lex_integer (lexer);
 249       if ( cstp->lo >= cstp->hi )
 250         {
 251           msg(ME,
 252               _("The specified value of HI (%d) is "
 253                 "lower than the specified value of LO (%d)"),
 254               cstp->hi, cstp->lo);
 255           return 0;
 256         }
 257       lex_get (lexer);
 258       if (! lex_force_match (lexer, ')')) return 0;
 259     }
 260
 261   cstp->n_expected = 0;
 262   cstp->expected = NULL;
 263   if ( lex_match (lexer, '/') )
 264     {
 265       if ( lex_match_id (lexer, "EXPECTED") )
 266         {
 267           lex_force_match (lexer, '=');
 268           if ( ! lex_match_id (lexer, "EQUAL") )
 269             {
 270               double f;
 271               int n;
 272               while ( lex_is_number(lexer) )
 273                 {
 274                   int i;
 275                   n = 1;
 276                   f = lex_number (lexer);
 277                   lex_get (lexer);
 278                   if ( lex_match (lexer, '*'))
 279                     {
 280                       n = f;
 281                       f = lex_number (lexer);
 282                       lex_get (lexer);
 283                     }
 284                   lex_match (lexer, ',');
 285
 286                   cstp->n_expected += n;
 287                   cstp->expected = pool_realloc (specs->pool,
 288                                                  cstp->expected,
 289                                                  sizeof(double) *
 290                                                  cstp->n_expected);
 291                   for ( i = cstp->n_expected - n ;
 292                         i < cstp->n_expected;
 293                         ++i )
 294                     cstp->expected[i] = f;
 295
 296                 }
 297             }
 298         }
 299       else
 300         lex_put_back (lexer, '/');
 301     }
 302
 303   if ( cstp->ranged && cstp->n_expected > 0 &&
 304        cstp->n_expected != cstp->hi - cstp->lo + 1 )
 305     {
 306       msg(ME,
 307           _("%d expected values were given, but the specified "
 308             "range (%d-%d) requires exactly %d values."),
 309           cstp->n_expected, cstp->lo, cstp->hi,
 310           cstp->hi - cstp->lo +1);
 311       return 0;
 312     }
 313
 314   specs->n_tests++;
 315   specs->test = pool_realloc (specs->pool,
 316                               specs->test,
 317                               sizeof(*specs->test) * specs->n_tests);
 318
 319   specs->test[specs->n_tests - 1] = (struct npar_test *) tp;
 320
 321   return 1;
 322 }
 323
 324
 325 int
 326 npar_custom_binomial (struct lexer *lexer, struct dataset *ds,
 327                       struct cmd_npar_tests *cmd UNUSED, void *aux)
 328 {
 329   struct npar_specs *specs = aux;
 330   struct binomial_test *btp = pool_alloc(specs->pool, sizeof(*btp));
 331   struct one_sample_test *tp = (struct one_sample_test *) btp;
 332
 333   ((struct npar_test *)tp)->execute = binomial_execute;
 334   ((struct npar_test *)tp)->insert_variables = one_sample_insert_variables;
 335
 336   btp->category1 = btp->category2 = btp->cutpoint = SYSMIS;
 337
 338   if ( lex_match(lexer, '(') )
 339     {
 340       if ( lex_force_num (lexer) )
 341         {
 342           btp->p = lex_number (lexer);
 343           lex_get (lexer);
 344           lex_force_match (lexer, ')');
 345         }
 346       else
 347         return 0;
 348     }
 349
 350   if ( lex_match (lexer, '=') )
 351     {
 352       if (parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
 353                                       &tp->vars, &tp->n_vars,
 354                                       PV_NUMERIC | PV_NO_SCRATCH | PV_NO_DUPLICATE) )
 355         {
 356           if ( lex_match (lexer, '('))
 357             {
 358               lex_force_num (lexer);
 359               btp->category1 = lex_number (lexer);
 360               lex_get (lexer);
 361               if ( lex_match (lexer, ','))
 362                 {
 363                   if ( ! lex_force_num (lexer) ) return 2;
 364                   btp->category2 = lex_number (lexer);
 365                   lex_get (lexer);
 366                 }
 367               else
 368                 {
 369                   btp->cutpoint = btp->category1;
 370                 }
 371
 372               lex_force_match (lexer, ')');
 373             }
 374         }
 375       else
 376         return 2;
 377     }
 378
 379   specs->n_tests++;
 380   specs->test = pool_realloc (specs->pool,
 381                               specs->test,
 382                               sizeof(*specs->test) * specs->n_tests);
 383
 384   specs->test[specs->n_tests - 1] = (struct npar_test *) tp;
 385
 386   return 1;
 387 }
 388
 389
 390 bool parse_two_sample_related_test (struct lexer *lexer,
 391                                     const struct dictionary *dict,
 392                                     struct cmd_npar_tests *cmd,
 393                                     struct two_sample_test *test_parameters,
 394                                     struct pool *pool
 395                                     );
 396
 397
 398 bool
 399 parse_two_sample_related_test (struct lexer *lexer,
 400                                const struct dictionary *dict,
 401                                struct cmd_npar_tests *cmd UNUSED,
 402                                struct two_sample_test *test_parameters,
 403                                struct pool *pool
 404                                )
 405 {
 406   int n = 0;
 407   bool paired = false;
 408   bool with = false;
 409   const struct variable **vlist1;
 410   size_t n_vlist1;
 411
 412   const struct variable **vlist2;
 413   size_t n_vlist2;
 414
 415   ((struct npar_test *)test_parameters)->insert_variables = two_sample_insert_variables;
 416
 417   if (!parse_variables_const_pool (lexer, pool,
 418                                    dict,
 419                                    &vlist1, &n_vlist1,
 420                                    PV_NUMERIC | PV_NO_SCRATCH | PV_NO_DUPLICATE) )
 421     return false;
 422
 423   if ( lex_match(lexer, T_WITH))
 424     {
 425       with = true;
 426       if ( !parse_variables_const_pool (lexer, pool, dict,
 427                                         &vlist2, &n_vlist2,
 428                                         PV_NUMERIC | PV_NO_SCRATCH | PV_NO_DUPLICATE) )
 429         return false;
 430
 431       paired = (lex_match (lexer, '(') &&
 432                 lex_match_id (lexer, "PAIRED") && lex_match (lexer, ')'));
 433     }
 434
 435
 436   if ( with )
 437     {
 438       if (paired)
 439         {
 440           if ( n_vlist1 != n_vlist2)
 441             msg (SE, _("PAIRED was specified but the number of variables "
 442                        "preceding WITH (%zu) did not match the number "
 443                        "following (%zu)."), n_vlist1, n_vlist2);
 444
 445           test_parameters->n_pairs = n_vlist1 ;
 446         }
 447       else
 448         {
 449           test_parameters->n_pairs = n_vlist1 * n_vlist2;
 450         }
 451     }
 452   else
 453     {
 454       test_parameters->n_pairs = (n_vlist1 * (n_vlist1 - 1)) / 2 ;
 455     }
 456
 457   test_parameters->pairs =
 458     pool_alloc (pool, sizeof ( variable_pair) * test_parameters->n_pairs);
 459
 460   if ( with )
 461     {
 462       if (paired)
 463         {
 464           int i;
 465           assert (n_vlist1 == n_vlist2);
 466           for ( i = 0 ; i < n_vlist1; ++i )
 467             {
 468               test_parameters->pairs[n][1] = vlist1[i];
 469               test_parameters->pairs[n][0] = vlist2[i];
 470               n++;
 471             }
 472         }
 473       else
 474         {
 475           int i,j;
 476           for ( i = 0 ; i < n_vlist1; ++i )
 477             {
 478               for ( j = 0 ; j < n_vlist2; ++j )
 479                 {
 480                   test_parameters->pairs[n][1] = vlist1[i];
 481                   test_parameters->pairs[n][0] = vlist2[j];
 482                   n++;
 483                 }
 484             }
 485         }
 486     }
 487   else
 488     {
 489       int i,j;
 490       for ( i = 0 ; i < n_vlist1 - 1; ++i )
 491         {
 492           for ( j = i + 1 ; j < n_vlist1; ++j )
 493             {
 494               assert ( n < test_parameters->n_pairs);
 495               test_parameters->pairs[n][1] = vlist1[i];
 496               test_parameters->pairs[n][0] = vlist1[j];
 497               n++;
 498             }
 499         }
 500     }
 501
 502   assert ( n == test_parameters->n_pairs);
 503
 504   return true;
 505 }
 506
 507 int
 508 npar_custom_wilcoxon (struct lexer *lexer,
 509                       struct dataset *ds,
 510                       struct cmd_npar_tests *cmd, void *aux )
 511 {
 512   struct npar_specs *specs = aux;
 513
 514   struct two_sample_test *tp = pool_alloc (specs->pool, sizeof(*tp));
 515   ((struct npar_test *)tp)->execute = wilcoxon_execute;
 516
 517   if (!parse_two_sample_related_test (lexer, dataset_dict (ds), cmd,
 518                                       tp, specs->pool) )
 519     return 0;
 520
 521   specs->n_tests++;
 522   specs->test = pool_realloc (specs->pool,
 523                               specs->test,
 524                               sizeof(*specs->test) * specs->n_tests);
 525   specs->test[specs->n_tests - 1] = (struct npar_test *) tp;
 526
 527   return 1;
 528 }
 529
 530 int
 531 npar_custom_mcnemar (struct lexer *lexer,
 532                      struct dataset *ds,
 533                      struct cmd_npar_tests *cmd, void *aux )
 534 {
 535   struct npar_specs *specs = aux;
 536
 537   struct two_sample_test *tp = pool_alloc(specs->pool, sizeof(*tp));
 538   ((struct npar_test *)tp)->execute = NULL;
 539
 540
 541   if (!parse_two_sample_related_test (lexer, dataset_dict (ds),
 542                                       cmd, tp, specs->pool) )
 543     return 0;
 544
 545   specs->n_tests++;
 546   specs->test = pool_realloc (specs->pool,
 547                               specs->test,
 548                               sizeof(*specs->test) * specs->n_tests);
 549   specs->test[specs->n_tests - 1] = (struct npar_test *) tp;
 550
 551   return 1;
 552 }
 553
 554 int
 555 npar_custom_sign (struct lexer *lexer, struct dataset *ds,
 556                   struct cmd_npar_tests *cmd, void *aux )
 557 {
 558   struct npar_specs *specs = aux;
 559
 560   struct two_sample_test *tp = pool_alloc(specs->pool, sizeof(*tp));
 561   ((struct npar_test *) tp)->execute = sign_execute;
 562
 563   if (!parse_two_sample_related_test (lexer, dataset_dict (ds), cmd,
 564                                       tp, specs->pool) )
 565     return 0;
 566
 567   specs->n_tests++;
 568   specs->test = pool_realloc (specs->pool,
 569                               specs->test,
 570                               sizeof(*specs->test) * specs->n_tests);
 571   specs->test[specs->n_tests - 1] = (struct npar_test *) tp;
 572
 573   return 1;
 574 }
 575
 576 /* Insert the variables for TEST into VAR_HASH */
 577 static void
 578 one_sample_insert_variables (const struct npar_test *test,
 579                              struct const_hsh_table *var_hash)
 580 {
 581   int i;
 582   struct one_sample_test *ost = (struct one_sample_test *) test;
 583
 584   for ( i = 0 ; i < ost->n_vars ; ++i )
 585     const_hsh_insert (var_hash, ost->vars[i]);
 586 }
 587
 588 static void
 589 two_sample_insert_variables (const struct npar_test *test,
 590                              struct const_hsh_table *var_hash)
 591 {
 592   int i;
 593
 594   const struct two_sample_test *tst = (const struct two_sample_test *) test;
 595
 596   for ( i = 0 ; i < tst->n_pairs ; ++i )
 597     {
 598       variable_pair *pair = &tst->pairs[i];
 599
 600       const_hsh_insert (var_hash, (*pair)[0]);
 601       const_hsh_insert (var_hash, (*pair)[1]);
 602     }
 603
 604 }
 605
 606
 607 static int
 608 npar_custom_method (struct lexer *lexer, struct dataset *ds UNUSED,
 609                     struct cmd_npar_tests *test UNUSED, void *aux)
 610 {
 611   struct npar_specs *specs = aux;
 612
 613   if ( lex_match_id (lexer, "EXACT") )
 614     {
 615       specs->exact = true;
 616       specs->timer = 0.0;
 617       if (lex_match_id (lexer, "TIMER"))
 618         {
 619           specs->timer = 5.0;
 620
 621           if ( lex_match (lexer, '('))
 622             {
 623               if ( lex_force_num (lexer) )
 624                 {
 625                   specs->timer = lex_number (lexer);
 626                   lex_get (lexer);
 627                 }
 628               lex_force_match (lexer, ')');
 629             }
 630         }
 631     }
 632
 633   return 1;
 634 }