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