src/language/stats/correlations.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 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 <libpspp/assertion.h>
  20 #include <math/covariance.h>
  21 #include <math/design-matrix.h>
  22 #include <gsl/gsl_matrix.h>
  23 #include <data/casegrouper.h>
  24 #include <data/casereader.h>
  25 #include <data/dictionary.h>
  26 #include <data/procedure.h>
  27 #include <data/variable.h>
  28 #include <language/command.h>
  29 #include <language/dictionary/split-file.h>
  30 #include <language/lexer/lexer.h>
  31 #include <language/lexer/variable-parser.h>
  32 #include <output/manager.h>
  33 #include <output/table.h>
  34 #include <libpspp/message.h>
  35 #include <data/format.h>
  36 #include <math/moments.h>
  37
  38 #include <math.h>
  39 #include "xalloc.h"
  40 #include "minmax.h"
  41 #include <libpspp/misc.h>
  42 #include <gsl/gsl_cdf.h>
  43
  44 #include "gettext.h"
  45 #define _(msgid) gettext (msgid)
  46 #define N_(msgid) msgid
  47
  48
  49 static double
  50 significance_of_correlation (double rho, double w)
  51 {
  52   double t = w - 2;
  53   t /= 1 - MIN (1, pow2 (rho));
  54   t = sqrt (t);
  55   t *= rho;
  56
  57   if (t > 0)
  58     return  gsl_cdf_tdist_Q (t, w - 2);
  59   else
  60     return  gsl_cdf_tdist_P (t, w - 2);
  61 }
  62
  63
  64 struct corr
  65 {
  66   size_t n_vars_total;
  67   size_t n_vars1;
  68
  69   const struct variable **vars;
  70 };
  71
  72
  73 /* Handling of missing values. */
  74 enum corr_missing_type
  75   {
  76     CORR_PAIRWISE,       /* Handle missing values on a per-variable-pair basis. */
  77     CORR_LISTWISE        /* Discard entire case if any variable is missing. */
  78   };
  79
  80 enum stats_opts
  81   {
  82     STATS_DESCRIPTIVES = 0x01,
  83     STATS_XPROD = 0x02,
  84     STATS_ALL = STATS_XPROD | STATS_DESCRIPTIVES
  85   };
  86
  87 struct corr_opts
  88 {
  89   enum corr_missing_type missing_type;
  90   enum mv_class exclude;      /* Classes of missing values to exclude. */
  91
  92   bool sig;   /* Flag significant values or not */
  93   int tails;  /* Report significance with how many tails ? */
  94   enum stats_opts statistics;
  95
  96   const struct variable *wv;  /* The weight variable (if any) */
  97 };
  98
  99
 100 static void
 101 output_descriptives (const struct corr *corr, const gsl_matrix *means,
 102                      const gsl_matrix *vars, const gsl_matrix *ns)
 103 {
 104   const int nr = corr->n_vars_total + 1;
 105   const int nc = 4;
 106   int c, r;
 107
 108   const int heading_columns = 1;
 109   const int heading_rows = 1;
 110
 111   struct tab_table *t = tab_create (nc, nr, 0);
 112   tab_title (t, _("Descriptive Statistics"));
 113   tab_dim (t, tab_natural_dimensions, NULL);
 114
 115   tab_headers (t, heading_columns, 0, heading_rows, 0);
 116
 117   /* Outline the box */
 118   tab_box (t,
 119            TAL_2, TAL_2,
 120            -1, -1,
 121            0, 0,
 122            nc - 1, nr - 1);
 123
 124   /* Vertical lines */
 125   tab_box (t,
 126            -1, -1,
 127            -1, TAL_1,
 128            heading_columns, 0,
 129            nc - 1, nr - 1);
 130
 131   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
 132   tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
 133
 134   tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Mean"));
 135   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Std. Deviation"));
 136   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("N"));
 137
 138   for (r = 0 ; r < corr->n_vars_total ; ++r)
 139     {
 140       const struct variable *v = corr->vars[r];
 141       tab_text (t, 0, r + heading_rows, TAB_LEFT | TAT_TITLE, var_to_string (v));
 142
 143       for (c = 1 ; c < nc ; ++c)
 144         {
 145           double x ;
 146           double n;
 147           switch (c)
 148             {
 149             case 1:
 150               x = gsl_matrix_get (means, r, 0);
 151               break;
 152             case 2:
 153               x = gsl_matrix_get (vars, r, 0);
 154
 155               /* Here we want to display the non-biased estimator */
 156               n = gsl_matrix_get (ns, r, 0);
 157               x *= n / (n -1);
 158
 159               x = sqrt (x);
 160               break;
 161             case 3:
 162               x = gsl_matrix_get (ns, r, 0);
 163               break;
 164             default:
 165               NOT_REACHED ();
 166             };
 167
 168           tab_double (t, c, r + heading_rows, 0, x, NULL);
 169         }
 170     }
 171
 172   tab_submit (t);
 173 }
 174
 175 static void
 176 output_correlation (const struct corr *corr, const struct corr_opts *opts,
 177                     const gsl_matrix *cm, const gsl_matrix *samples)
 178 {
 179   int r, c;
 180   struct tab_table *t;
 181   int matrix_cols;
 182   int nr = corr->n_vars1;
 183   int nc = matrix_cols = corr->n_vars_total > corr->n_vars1 ?
 184     corr->n_vars_total - corr->n_vars1 : corr->n_vars1;
 185
 186   const struct fmt_spec *wfmt = opts->wv ? var_get_print_format (opts->wv) : & F_8_0;
 187
 188   const int heading_columns = 2;
 189   const int heading_rows = 1;
 190
 191   const int rows_per_variable = opts->missing_type == CORR_LISTWISE ? 2 : 3;
 192
 193   /* Two header columns */
 194   nc += heading_columns;
 195
 196   /* Three data per variable */
 197   nr *= rows_per_variable;
 198
 199   /* One header row */
 200   nr += heading_rows;
 201
 202   t = tab_create (nc, nr, 0);
 203   tab_title (t, _("Correlations"));
 204   tab_dim (t, tab_natural_dimensions, NULL);
 205
 206   tab_headers (t, heading_columns, 0, heading_rows, 0);
 207
 208   /* Outline the box */
 209   tab_box (t,
 210            TAL_2, TAL_2,
 211            -1, -1,
 212            0, 0,
 213            nc - 1, nr - 1);
 214
 215   /* Vertical lines */
 216   tab_box (t,
 217            -1, -1,
 218            -1, TAL_1,
 219            heading_columns, 0,
 220            nc - 1, nr - 1);
 221
 222   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
 223   tab_vline (t, TAL_1, 1, heading_rows, nr - 1);
 224
 225   for (r = 0 ; r < corr->n_vars1 ; ++r)
 226     {
 227       tab_text (t, 0, 1 + r * rows_per_variable, TAB_LEFT | TAT_TITLE,
 228                 var_to_string (corr->vars[r]));
 229
 230       tab_text (t, 1, 1 + r * rows_per_variable, TAB_LEFT | TAT_TITLE, _("Pearson Correlation"));
 231       tab_text (t, 1, 2 + r * rows_per_variable, TAB_LEFT | TAT_TITLE,
 232                 (opts->tails == 2) ? _("Sig. (2-tailed)") : _("Sig. (1-tailed)"));
 233       if ( opts->missing_type != CORR_LISTWISE )
 234         tab_text (t, 1, 3 + r * rows_per_variable, TAB_LEFT | TAT_TITLE, _("N"));
 235       tab_hline (t, TAL_1, 0, nc - 1, r * rows_per_variable + 1);
 236     }
 237
 238   for (c = 0 ; c < matrix_cols ; ++c)
 239     {
 240       const struct variable *v = corr->n_vars_total > corr->n_vars1 ? corr->vars[corr->n_vars_total - corr->n_vars1 + c] : corr->vars[c];
 241       tab_text (t, heading_columns + c, 0, TAB_LEFT | TAT_TITLE, var_to_string (v));
 242     }
 243
 244   for (r = 0 ; r < corr->n_vars1 ; ++r)
 245     {
 246       const int row = r * rows_per_variable + heading_rows;
 247       for (c = 0 ; c < matrix_cols ; ++c)
 248         {
 249           unsigned char flags = 0;
 250           int col_index = corr->n_vars_total - corr->n_vars1 + c;
 251           double pearson = gsl_matrix_get (cm, r, col_index);
 252           double w = gsl_matrix_get (samples, r, col_index);
 253           double sig = opts->tails * significance_of_correlation (pearson, w);
 254
 255           if ( opts->missing_type != CORR_LISTWISE )
 256             tab_double (t, c + heading_columns, row + 2, 0, w, wfmt);
 257
 258           if ( c != r)
 259             tab_double (t, c + heading_columns, row + 1, 0,  sig, NULL);
 260
 261           if ( opts->sig && c != r && sig < 0.05)
 262             flags = TAB_EMPH;
 263
 264           tab_double (t, c + heading_columns, row, flags, pearson, NULL);
 265         }
 266     }
 267
 268   tab_submit (t);
 269 }
 270
 271
 272 static gsl_matrix *
 273 correlation_from_covariance (const gsl_matrix *cv, const gsl_matrix *v)
 274 {
 275   size_t i, j;
 276   gsl_matrix *corr = gsl_matrix_calloc (cv->size1, cv->size2);
 277
 278   for (i = 0 ; i < cv->size1; ++i)
 279     {
 280       for (j = 0 ; j < cv->size2; ++j)
 281         {
 282           double rho = gsl_matrix_get (cv, i, j);
 283
 284           rho /= sqrt (gsl_matrix_get (v, i, j))
 285             *
 286             sqrt (gsl_matrix_get (v, j, i));
 287
 288           gsl_matrix_set (corr, i, j, rho);
 289         }
 290     }
 291
 292   return corr;
 293 }
 294
 295
 296
 297
 298 static void
 299 run_corr (struct casereader *r, const struct corr_opts *opts, const struct corr *corr)
 300 {
 301   struct ccase *c;
 302   const gsl_matrix *var_matrix,  *samples_matrix, *mean_matrix;
 303   const gsl_matrix *cov_matrix;
 304   gsl_matrix *corr_matrix;
 305   struct covariance *cov = covariance_create (corr->n_vars_total, corr->vars,
 306                                               opts->wv, opts->exclude);
 307
 308   for ( ; (c = casereader_read (r) ); case_unref (c))
 309     {
 310       covariance_accumulate (cov, c);
 311     }
 312
 313   cov_matrix = covariance_calculate (cov);
 314
 315   samples_matrix = covariance_moments (cov, MOMENT_NONE);
 316   var_matrix = covariance_moments (cov, MOMENT_VARIANCE);
 317   mean_matrix = covariance_moments (cov, MOMENT_MEAN);
 318
 319   corr_matrix = correlation_from_covariance (cov_matrix, var_matrix);
 320
 321   if ( opts->statistics & STATS_DESCRIPTIVES)
 322     output_descriptives (corr, mean_matrix, var_matrix, samples_matrix);
 323
 324   output_correlation (corr, opts,
 325                       corr_matrix,
 326                       samples_matrix );
 327
 328   covariance_destroy (cov);
 329   gsl_matrix_free (corr_matrix);
 330 }
 331
 332 int
 333 cmd_correlation (struct lexer *lexer, struct dataset *ds)
 334 {
 335   int i;
 336   int n_all_vars = 0; /* Total number of variables involved in this command */
 337   const struct variable **all_vars ;
 338   const struct dictionary *dict = dataset_dict (ds);
 339   bool ok = true;
 340
 341   struct casegrouper *grouper;
 342   struct casereader *group;
 343
 344   struct corr *corr = NULL;
 345   size_t n_corrs = 0;
 346
 347   struct corr_opts opts;
 348   opts.missing_type = CORR_PAIRWISE;
 349   opts.wv = dict_get_weight (dict);
 350   opts.tails = 2;
 351   opts.sig = false;
 352   opts.exclude = MV_ANY;
 353   opts.statistics = 0;
 354
 355   /* Parse CORRELATIONS. */
 356   while (lex_token (lexer) != '.')
 357     {
 358       lex_match (lexer, '/');
 359       if (lex_match_id (lexer, "MISSING"))
 360         {
 361           lex_match (lexer, '=');
 362           while (lex_token (lexer) != '.' && lex_token (lexer) != '/')
 363             {
 364               if (lex_match_id (lexer, "PAIRWISE"))
 365                 opts.missing_type = CORR_PAIRWISE;
 366               else if (lex_match_id (lexer, "LISTWISE"))
 367                 opts.missing_type = CORR_LISTWISE;
 368
 369               else if (lex_match_id (lexer, "INCLUDE"))
 370                 opts.exclude = MV_SYSTEM;
 371               else if (lex_match_id (lexer, "EXCLUDE"))
 372                 opts.exclude = MV_ANY;
 373               else
 374                 {
 375                   lex_error (lexer, NULL);
 376                   goto error;
 377                 }
 378               lex_match (lexer, ',');
 379             }
 380         }
 381       else if (lex_match_id (lexer, "PRINT"))
 382         {
 383           lex_match (lexer, '=');
 384           while (lex_token (lexer) != '.' && lex_token (lexer) != '/')
 385             {
 386               if ( lex_match_id (lexer, "TWOTAIL"))
 387                 opts.tails = 2;
 388               else if (lex_match_id (lexer, "ONETAIL"))
 389                 opts.tails = 1;
 390               else if (lex_match_id (lexer, "SIG"))
 391                 opts.sig = false;
 392               else if (lex_match_id (lexer, "NOSIG"))
 393                 opts.sig = true;
 394               else
 395                 {
 396                   lex_error (lexer, NULL);
 397                   goto error;
 398                 }
 399
 400               lex_match (lexer, ',');
 401             }
 402         }
 403       else if (lex_match_id (lexer, "STATISTICS"))
 404         {
 405           lex_match (lexer, '=');
 406           while (lex_token (lexer) != '.' && lex_token (lexer) != '/')
 407             {
 408               if ( lex_match_id (lexer, "DESCRIPTIVES"))
 409                 opts.statistics = STATS_DESCRIPTIVES;
 410               else if (lex_match_id (lexer, "XPROD"))
 411                 opts.statistics = STATS_XPROD;
 412               else
 413                 opts.statistics = STATS_ALL;
 414
 415               lex_match (lexer, ',');
 416             }
 417         }
 418       else
 419         {
 420           if (lex_match_id (lexer, "VARIABLES"))
 421             {
 422               lex_match (lexer, '=');
 423             }
 424
 425           corr = xrealloc (corr, sizeof (*corr) * (n_corrs + 1));
 426           corr[n_corrs].n_vars_total = corr[n_corrs].n_vars1 = 0;
 427
 428           if ( ! parse_variables_const (lexer, dict, &corr[n_corrs].vars,
 429                                         &corr[n_corrs].n_vars_total,
 430                                         PV_NUMERIC))
 431             {
 432               ok = false;
 433               break;
 434             }
 435
 436
 437           corr[n_corrs].n_vars1 = corr[n_corrs].n_vars_total;
 438
 439           if ( lex_match (lexer, T_WITH))
 440             {
 441               if ( ! parse_variables_const (lexer, dict,
 442                                             &corr[n_corrs].vars, &corr[n_corrs].n_vars_total,
 443                                             PV_NUMERIC | PV_APPEND))
 444                 {
 445                   ok = false;
 446                   break;
 447                 }
 448             }
 449
 450           n_all_vars += corr[n_corrs].n_vars_total;
 451
 452           n_corrs++;
 453         }
 454     }
 455
 456   if (n_corrs == 0)
 457     {
 458       msg (SE, _("No variables specified."));
 459       goto error;
 460     }
 461
 462
 463   all_vars = xmalloc (sizeof (*all_vars) * n_all_vars);
 464
 465   {
 466     /* FIXME:  Using a hash here would make more sense */
 467     const struct variable **vv = all_vars;
 468
 469     for (i = 0 ; i < n_corrs; ++i)
 470       {
 471         int v;
 472         const struct corr *c = &corr[i];
 473         for (v = 0 ; v < c->n_vars_total; ++v)
 474           *vv++ = c->vars[v];
 475       }
 476   }
 477
 478   grouper = casegrouper_create_splits (proc_open (ds), dict);
 479
 480   while (casegrouper_get_next_group (grouper, &group))
 481     {
 482       for (i = 0 ; i < n_corrs; ++i)
 483         {
 484           /* FIXME: No need to iterate the data multiple times */
 485           struct casereader *r = casereader_clone (group);
 486
 487           if ( opts.missing_type == CORR_LISTWISE)
 488             r = casereader_create_filter_missing (r, all_vars, n_all_vars,
 489                                                   opts.exclude, NULL, NULL);
 490
 491
 492           run_corr (r, &opts,  &corr[i]);
 493           casereader_destroy (r);
 494         }
 495       casereader_destroy (group);
 496     }
 497
 498   ok = casegrouper_destroy (grouper);
 499   ok = proc_commit (ds) && ok;
 500
 501   free (all_vars);
 502
 503
 504   /* Done. */
 505   free (corr);
 506   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
 507
 508  error:
 509   free (corr);
 510   return CMD_FAILURE;
 511 }