REGRESSION: Warn when REGRESSION with SAVE runs with a filter configured.
[pspp] / src / language / stats / regression.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2016 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 <float.h>
20 #include <stdbool.h>
21
22 #include <gsl/gsl_cdf.h>
23 #include <gsl/gsl_matrix.h>
24
25 #include <data/dataset.h>
26 #include <data/casewriter.h>
27
28 #include "language/command.h"
29 #include "language/lexer/lexer.h"
30 #include "language/lexer/value-parser.h"
31 #include "language/lexer/variable-parser.h"
32
33
34 #include "data/casegrouper.h"
35 #include "data/casereader.h"
36 #include "data/dictionary.h"
37
38 #include "math/covariance.h"
39 #include "math/linreg.h"
40 #include "math/moments.h"
41
42 #include "libpspp/message.h"
43 #include "libpspp/taint.h"
44
45 #include "output/tab.h"
46
47 #include "gettext.h"
48 #define _(msgid) gettext (msgid)
49 #define N_(msgid) msgid
50
51
52 #include <gl/intprops.h>
53
54 #define REG_LARGE_DATA 1000
55
56 #define STATS_R      1
57 #define STATS_COEFF  2
58 #define STATS_ANOVA  4
59 #define STATS_OUTS   8
60 #define STATS_CI    16
61 #define STATS_BCOV  32
62
63 #define STATS_DEFAULT  (STATS_R | STATS_COEFF | STATS_ANOVA | STATS_OUTS)
64
65
66
67 struct regression
68 {
69   struct dataset *ds;
70
71   const struct variable **vars;
72   size_t n_vars;
73
74   const struct variable **dep_vars;
75   size_t n_dep_vars;
76
77   unsigned int stats;
78   double ci;
79
80   bool resid;
81   bool pred;
82 };
83
84 struct regression_workspace
85 {
86   /* The new variables which will be introduced by /SAVE */
87   const struct variable **predvars; 
88   const struct variable **residvars;
89
90   /* A reader/writer pair to temporarily hold the 
91      values of the new variables */
92   struct casewriter *writer;
93   struct casereader *reader;
94
95   /* Indeces of the new values in the reader/writer (-1 if not applicable) */
96   int res_idx;
97   int pred_idx;
98
99   /* 0, 1 or 2 depending on what new variables are to be created */
100   int extras;
101 };
102
103 static void run_regression (const struct regression *cmd,
104                             struct regression_workspace *ws,
105                             struct casereader *input);
106
107
108 /* Return a string based on PREFIX which may be used as the name
109    of a new variable in DICT */
110 static char *
111 reg_get_name (const struct dictionary *dict, const char *prefix)
112 {
113   char *name;
114   int i;
115
116   /* XXX handle too-long prefixes */
117   name = xmalloc (strlen (prefix) + INT_BUFSIZE_BOUND (i) + 1);
118   for (i = 1;; i++)
119     {
120       sprintf (name, "%s%d", prefix, i);
121       if (dict_lookup_var (dict, name) == NULL)
122         return name;
123     }
124 }
125
126
127 static const struct variable *
128 create_aux_var (struct dataset *ds, const char *prefix)
129 {
130   struct variable *var;
131   struct dictionary *dict = dataset_dict (ds);
132   char *name = reg_get_name (dict, prefix);
133   var = dict_create_var_assert (dict, name, 0);
134   free (name);
135   return var;
136 }
137
138 /* Auxilliary data for transformation when /SAVE is entered */
139 struct save_trans_data
140 {
141   int n_dep_vars;
142   struct regression_workspace *ws;
143 };
144
145 static bool
146 save_trans_free (void *aux)
147 {
148   struct save_trans_data *save_trans_data = aux;
149   free (save_trans_data->ws->predvars);
150   free (save_trans_data->ws->residvars);
151
152   casereader_destroy (save_trans_data->ws->reader);
153   free (save_trans_data->ws);
154   free (save_trans_data);
155   return true;
156 }
157
158 static int 
159 save_trans_func (void *aux, struct ccase **c, casenumber x UNUSED)
160 {
161   struct save_trans_data *save_trans_data = aux;
162   struct regression_workspace *ws = save_trans_data->ws;
163   struct ccase *in =  casereader_read (ws->reader);
164
165   if (in)
166     {
167       int k;
168       *c = case_unshare (*c);
169
170       for (k = 0; k < save_trans_data->n_dep_vars; ++k)
171         {
172           if (ws->pred_idx != -1)
173             {
174               double pred = case_data_idx (in, ws->extras * k + ws->pred_idx)->f;
175               case_data_rw (*c, ws->predvars[k])->f = pred;
176             }
177           
178           if (ws->res_idx != -1)
179             {
180               double resid = case_data_idx (in, ws->extras * k + ws->res_idx)->f;
181               case_data_rw (*c, ws->residvars[k])->f = resid;
182             }
183         }
184       case_unref (in);
185     }
186
187   return TRNS_CONTINUE;
188 }
189
190
191 int
192 cmd_regression (struct lexer *lexer, struct dataset *ds)
193 {
194   struct regression_workspace workspace;
195   struct regression regression;
196   const struct dictionary *dict = dataset_dict (ds);
197   bool save;
198
199   memset (&regression, 0, sizeof (struct regression));
200
201   regression.ci = 0.95;
202   regression.stats = STATS_DEFAULT;
203   regression.pred = false;
204   regression.resid = false;
205
206   regression.ds = ds;
207
208   /* Accept an optional, completely pointless "/VARIABLES=" */
209   lex_match (lexer, T_SLASH);
210   if (lex_match_id (lexer, "VARIABLES"))
211     {
212       if (!lex_force_match (lexer, T_EQUALS))
213         goto error;
214     }
215
216   if (!parse_variables_const (lexer, dict,
217                               &regression.vars, &regression.n_vars,
218                               PV_NO_DUPLICATE | PV_NUMERIC))
219     goto error;
220
221
222   while (lex_token (lexer) != T_ENDCMD)
223     {
224       lex_match (lexer, T_SLASH);
225
226       if (lex_match_id (lexer, "DEPENDENT"))
227         {
228           lex_match (lexer, T_EQUALS);
229
230           free (regression.dep_vars);
231           regression.n_dep_vars = 0;
232           
233           if (!parse_variables_const (lexer, dict,
234                                       &regression.dep_vars,
235                                       &regression.n_dep_vars,
236                                       PV_NO_DUPLICATE | PV_NUMERIC))
237             goto error;
238         }
239       else if (lex_match_id (lexer, "METHOD"))
240         {
241           lex_match (lexer, T_EQUALS);
242
243           if (!lex_force_match_id (lexer, "ENTER"))
244             {
245               goto error;
246             }
247         }
248       else if (lex_match_id (lexer, "STATISTICS"))
249         {
250           unsigned long statistics = 0;
251           lex_match (lexer, T_EQUALS);
252
253           while (lex_token (lexer) != T_ENDCMD
254                  && lex_token (lexer) != T_SLASH)
255             {
256               if (lex_match (lexer, T_ALL))
257                 {
258                   statistics = ~0;
259                 }
260               else if (lex_match_id (lexer, "DEFAULTS"))
261                 {
262                   statistics |= STATS_DEFAULT;
263                 }
264               else if (lex_match_id (lexer, "R"))
265                 {
266                   statistics |= STATS_R;
267                 }
268               else if (lex_match_id (lexer, "COEFF"))
269                 {
270                   statistics |= STATS_COEFF;
271                 }
272               else if (lex_match_id (lexer, "ANOVA"))
273                 {
274                   statistics |= STATS_ANOVA;
275                 }
276               else if (lex_match_id (lexer, "BCOV"))
277                 {
278                   statistics |= STATS_BCOV;
279                 }
280               else if (lex_match_id (lexer, "CI"))
281                 {
282                   statistics |= STATS_CI;
283
284                   if (lex_match (lexer, T_LPAREN))
285                     {
286                       regression.ci = lex_number (lexer) / 100.0;
287                       lex_get (lexer);
288                       lex_force_match (lexer, T_RPAREN);
289                     }
290                 }
291               else
292                 {
293                   lex_error (lexer, NULL);
294                   goto error;
295                 }
296             }
297
298           if (statistics)
299             regression.stats = statistics;
300
301         }
302       else if (lex_match_id (lexer, "SAVE"))
303         {
304           lex_match (lexer, T_EQUALS);
305
306           while (lex_token (lexer) != T_ENDCMD
307                  && lex_token (lexer) != T_SLASH)
308             {
309               if (lex_match_id (lexer, "PRED"))
310                 {
311                   regression.pred = true;
312                 }
313               else if (lex_match_id (lexer, "RESID"))
314                 {
315                   regression.resid = true;
316                 }
317               else
318                 {
319                   lex_error (lexer, NULL);
320                   goto error;
321                 }
322             }
323         }
324       else
325         {
326           lex_error (lexer, NULL);
327           goto error;
328         }
329     }
330
331   if (!regression.vars)
332     {
333       dict_get_vars (dict, &regression.vars, &regression.n_vars, 0);
334     }
335
336   save = regression.pred || regression.resid;
337   workspace.extras = 0;
338   workspace.res_idx = -1;
339   workspace.pred_idx = -1;
340   workspace.writer = NULL;                      
341   workspace.reader = NULL;
342   workspace.residvars = NULL;
343   workspace.predvars = NULL;
344   if (save)
345     {
346       int i;
347       struct caseproto *proto = caseproto_create ();
348
349       if (regression.resid)
350         {
351           workspace.extras ++;
352           workspace.res_idx = 0;
353           workspace.residvars = xcalloc (regression.n_dep_vars, sizeof (*workspace.residvars));
354
355           for (i = 0; i < regression.n_dep_vars; ++i)
356             {
357               workspace.residvars[i] = create_aux_var (ds, "RES");
358               proto = caseproto_add_width (proto, 0);
359             }
360         }
361
362       if (regression.pred)
363         {
364           workspace.extras ++;
365           workspace.pred_idx = 1;
366           workspace.predvars = xcalloc (regression.n_dep_vars, sizeof (*workspace.predvars));
367
368           for (i = 0; i < regression.n_dep_vars; ++i)
369             {
370               workspace.predvars[i] = create_aux_var (ds, "PRED");
371               proto = caseproto_add_width (proto, 0);
372             }
373         }
374
375       if (proc_make_temporary_transformations_permanent (ds))
376         msg (SW, _("REGRESSION with SAVE ignores TEMPORARY.  "
377                    "Temporary transformations will be made permanent."));
378
379       if (dict_get_filter (dict))
380         msg (SW, _("REGRESSION with SAVE ignores FILTER.  "
381                    "All cases will be processed."));
382
383       workspace.writer = autopaging_writer_create (proto);
384       caseproto_unref (proto);
385     }
386
387
388   {
389     struct casegrouper *grouper;
390     struct casereader *group;
391     bool ok;
392
393     grouper = casegrouper_create_splits (proc_open_filtering (ds, !save), dict);
394
395
396     while (casegrouper_get_next_group (grouper, &group))
397       {
398         run_regression (&regression,
399                         &workspace,
400                         group);
401
402       }
403     ok = casegrouper_destroy (grouper);
404     ok = proc_commit (ds) && ok;
405   }
406
407   if (workspace.writer)
408     {
409       struct save_trans_data *save_trans_data = xmalloc (sizeof *save_trans_data);
410       struct casereader *r = casewriter_make_reader (workspace.writer);
411       workspace.writer = NULL;
412       workspace.reader = r;
413       save_trans_data->ws = xmalloc (sizeof (workspace));
414       memcpy (save_trans_data->ws, &workspace, sizeof (workspace));
415       save_trans_data->n_dep_vars = regression.n_dep_vars;
416           
417       add_transformation (ds, save_trans_func, save_trans_free, save_trans_data);
418     }
419
420
421   free (regression.vars);
422   free (regression.dep_vars);
423   return CMD_SUCCESS;
424
425 error:
426
427   free (regression.vars);
428   free (regression.dep_vars);
429   return CMD_FAILURE;
430 }
431
432 /* Return the size of the union of dependent and independent variables */
433 static size_t
434 get_n_all_vars (const struct regression *cmd)
435 {
436   size_t result = cmd->n_vars;
437   size_t i;
438   size_t j;
439
440   result += cmd->n_dep_vars;
441   for (i = 0; i < cmd->n_dep_vars; i++)
442     {
443       for (j = 0; j < cmd->n_vars; j++)
444         {
445           if (cmd->vars[j] == cmd->dep_vars[i])
446             {
447               result--;
448             }
449         }
450     }
451   return result;
452 }
453
454 /* Fill VARS with the union of dependent and independent variables */
455 static void
456 fill_all_vars (const struct variable **vars, const struct regression *cmd)
457 {
458   size_t x = 0;
459   size_t i;
460   for (i = 0; i < cmd->n_vars; i++)
461     {
462       vars[i] = cmd->vars[i];
463     }
464
465   for (i = 0; i < cmd->n_dep_vars; i++)
466     {
467       size_t j;
468       bool absent = true;
469       for (j = 0; j < cmd->n_vars; j++)
470         {
471           if (cmd->dep_vars[i] == cmd->vars[j])
472             {
473               absent = false;
474               break;
475             }
476         }
477       if (absent)
478         {
479           vars[cmd->n_vars + x++] = cmd->dep_vars[i];
480         }
481     }
482 }
483
484 /*
485   Is variable k the dependent variable?
486 */
487 static bool
488 is_depvar (const struct regression *cmd, size_t k, const struct variable *v)
489 {
490   return v == cmd->vars[k];
491 }
492
493
494 /* Identify the explanatory variables in v_variables.  Returns
495    the number of independent variables. */
496 static int
497 identify_indep_vars (const struct regression *cmd,
498                      const struct variable **indep_vars,
499                      const struct variable *depvar)
500 {
501   int n_indep_vars = 0;
502   int i;
503
504   for (i = 0; i < cmd->n_vars; i++)
505     if (!is_depvar (cmd, i, depvar))
506       indep_vars[n_indep_vars++] = cmd->vars[i];
507   if ((n_indep_vars < 1) && is_depvar (cmd, 0, depvar))
508     {
509       /*
510          There is only one independent variable, and it is the same
511          as the dependent variable. Print a warning and continue.
512        */
513       msg (SW,
514            gettext
515            ("The dependent variable is equal to the independent variable. "
516             "The least squares line is therefore Y=X. "
517             "Standard errors and related statistics may be meaningless."));
518       n_indep_vars = 1;
519       indep_vars[0] = cmd->vars[0];
520     }
521   return n_indep_vars;
522 }
523
524
525 static double
526 fill_covariance (gsl_matrix * cov, struct covariance *all_cov,
527                  const struct variable **vars,
528                  size_t n_vars, const struct variable *dep_var,
529                  const struct variable **all_vars, size_t n_all_vars,
530                  double *means)
531 {
532   size_t i;
533   size_t j;
534   size_t dep_subscript;
535   size_t *rows;
536   const gsl_matrix *ssizes;
537   const gsl_matrix *mean_matrix;
538   const gsl_matrix *ssize_matrix;
539   double result = 0.0;
540
541   const gsl_matrix *cm = covariance_calculate_unnormalized (all_cov);
542
543   if (cm == NULL)
544     return 0;
545
546   rows = xnmalloc (cov->size1 - 1, sizeof (*rows));
547
548   for (i = 0; i < n_all_vars; i++)
549     {
550       for (j = 0; j < n_vars; j++)
551         {
552           if (vars[j] == all_vars[i])
553             {
554               rows[j] = i;
555             }
556         }
557       if (all_vars[i] == dep_var)
558         {
559           dep_subscript = i;
560         }
561     }
562   mean_matrix = covariance_moments (all_cov, MOMENT_MEAN);
563   ssize_matrix = covariance_moments (all_cov, MOMENT_NONE);
564   for (i = 0; i < cov->size1 - 1; i++)
565     {
566       means[i] = gsl_matrix_get (mean_matrix, rows[i], 0)
567         / gsl_matrix_get (ssize_matrix, rows[i], 0);
568       for (j = 0; j < cov->size2 - 1; j++)
569         {
570           gsl_matrix_set (cov, i, j, gsl_matrix_get (cm, rows[i], rows[j]));
571           gsl_matrix_set (cov, j, i, gsl_matrix_get (cm, rows[j], rows[i]));
572         }
573     }
574   means[cov->size1 - 1] = gsl_matrix_get (mean_matrix, dep_subscript, 0)
575     / gsl_matrix_get (ssize_matrix, dep_subscript, 0);
576   ssizes = covariance_moments (all_cov, MOMENT_NONE);
577   result = gsl_matrix_get (ssizes, dep_subscript, rows[0]);
578   for (i = 0; i < cov->size1 - 1; i++)
579     {
580       gsl_matrix_set (cov, i, cov->size1 - 1,
581                       gsl_matrix_get (cm, rows[i], dep_subscript));
582       gsl_matrix_set (cov, cov->size1 - 1, i,
583                       gsl_matrix_get (cm, rows[i], dep_subscript));
584       if (result > gsl_matrix_get (ssizes, rows[i], dep_subscript))
585         {
586           result = gsl_matrix_get (ssizes, rows[i], dep_subscript);
587         }
588     }
589   gsl_matrix_set (cov, cov->size1 - 1, cov->size1 - 1,
590                   gsl_matrix_get (cm, dep_subscript, dep_subscript));
591   free (rows);
592   return result;
593 }
594
595 \f
596
597 /*
598   STATISTICS subcommand output functions.
599 */
600 static void reg_stats_r (const linreg *,     const struct variable *);
601 static void reg_stats_coeff (const linreg *, const gsl_matrix *, const struct variable *, const struct regression *);
602 static void reg_stats_anova (const linreg *, const struct variable *);
603 static void reg_stats_bcov (const linreg *,  const struct variable *);
604
605
606 static void
607 subcommand_statistics (const struct regression *cmd, const linreg * c, const gsl_matrix * cm,
608                        const struct variable *var)
609 {
610   if (cmd->stats & STATS_R) 
611     reg_stats_r     (c, var);
612
613   if (cmd->stats & STATS_ANOVA) 
614     reg_stats_anova (c, var);
615
616   if (cmd->stats & STATS_COEFF)
617     reg_stats_coeff (c, cm, var, cmd);
618
619   if (cmd->stats & STATS_BCOV)
620     reg_stats_bcov  (c, var);
621 }
622
623
624 static void
625 run_regression (const struct regression *cmd, 
626                 struct regression_workspace *ws,
627                 struct casereader *input)
628 {
629   size_t i;
630   linreg **models;
631
632   int k;
633   struct ccase *c;
634   struct covariance *cov;
635   struct casereader *reader;
636   size_t n_all_vars = get_n_all_vars (cmd);
637   const struct variable **all_vars = xnmalloc (n_all_vars, sizeof (*all_vars));
638
639   double *means = xnmalloc (n_all_vars, sizeof (*means));
640
641   fill_all_vars (all_vars, cmd);
642   cov = covariance_1pass_create (n_all_vars, all_vars,
643                                  dict_get_weight (dataset_dict (cmd->ds)),
644                                  MV_ANY);
645
646   reader = casereader_clone (input);
647   reader = casereader_create_filter_missing (reader, all_vars, n_all_vars,
648                                              MV_ANY, NULL, NULL);
649
650
651   {
652     struct casereader *r = casereader_clone (reader);
653
654     for (; (c = casereader_read (r)) != NULL; case_unref (c))
655       {
656         covariance_accumulate (cov, c);
657       }
658     casereader_destroy (r);
659   }
660
661   models = xcalloc (cmd->n_dep_vars, sizeof (*models));
662   for (k = 0; k < cmd->n_dep_vars; k++)
663     {
664       const struct variable **vars = xnmalloc (cmd->n_vars, sizeof (*vars));
665       const struct variable *dep_var = cmd->dep_vars[k];
666       int n_indep = identify_indep_vars (cmd, vars, dep_var);
667       gsl_matrix *this_cm = gsl_matrix_alloc (n_indep + 1, n_indep + 1);
668       double n_data = fill_covariance (this_cm, cov, vars, n_indep,
669                                 dep_var, all_vars, n_all_vars, means);
670       models[k] = linreg_alloc (dep_var, vars,  n_data, n_indep);
671       models[k]->depvar = dep_var;
672       for (i = 0; i < n_indep; i++)
673         {
674           linreg_set_indep_variable_mean (models[k], i, means[i]);
675         }
676       linreg_set_depvar_mean (models[k], means[i]);
677       /*
678          For large data sets, use QR decomposition.
679        */
680       if (n_data > sqrt (n_indep) && n_data > REG_LARGE_DATA)
681         {
682           models[k]->method = LINREG_QR;
683         }
684
685       if (n_data > 0)
686         {
687           /*
688              Find the least-squares estimates and other statistics.
689            */
690           linreg_fit (this_cm, models[k]);
691
692           if (!taint_has_tainted_successor (casereader_get_taint (input)))
693             {
694               subcommand_statistics (cmd, models[k], this_cm, dep_var);
695             }
696         }
697       else
698         {
699           msg (SE, _("No valid data found. This command was skipped."));
700         }
701       gsl_matrix_free (this_cm);
702       free (vars);
703     }
704
705
706   if (ws->extras > 0)
707    {
708       struct casereader *r = casereader_clone (reader);
709       
710       for (; (c = casereader_read (r)) != NULL; case_unref (c))
711         {
712           struct ccase *outc = case_clone (c);
713           for (k = 0; k < cmd->n_dep_vars; k++)
714             {
715               const struct variable **vars = xnmalloc (cmd->n_vars, sizeof (*vars));
716               const struct variable *dep_var = cmd->dep_vars[k];
717               int n_indep = identify_indep_vars (cmd, vars, dep_var);
718               double *vals = xnmalloc (n_indep, sizeof (*vals));
719               for (i = 0; i < n_indep; i++)
720                 {
721                   const union value *tmp = case_data (c, vars[i]);
722                   vals[i] = tmp->f;
723                 }
724
725               if (cmd->pred)
726                 {
727                   double pred = linreg_predict (models[k], vals, n_indep);
728                   case_data_rw_idx (outc, k * ws->extras + ws->pred_idx)->f = pred;
729                 }
730
731               if (cmd->resid)
732                 {
733                   double obs = case_data (c, models[k]->depvar)->f;
734                   double res = linreg_residual (models[k], obs,  vals, n_indep);
735                   case_data_rw_idx (outc, k * ws->extras + ws->res_idx)->f = res;
736                 }
737               free (vals);
738               free (vars);
739             }          
740           casewriter_write (ws->writer, outc);
741         }
742       casereader_destroy (r);
743     }
744
745   casereader_destroy (reader);
746
747   for (k = 0; k < cmd->n_dep_vars; k++)
748     {
749       linreg_unref (models[k]);
750     }
751   free (models);
752
753   free (all_vars);
754   free (means);
755   casereader_destroy (input);
756   covariance_destroy (cov);
757 }
758
759 \f
760
761
762 static void
763 reg_stats_r (const linreg * c, const struct variable *var)
764 {
765   struct tab_table *t;
766   int n_rows = 2;
767   int n_cols = 5;
768   double rsq;
769   double adjrsq;
770   double std_error;
771
772   assert (c != NULL);
773   rsq = linreg_ssreg (c) / linreg_sst (c);
774   adjrsq = rsq -
775     (1.0 - rsq) * linreg_n_coeffs (c) / (linreg_n_obs (c) -
776                                          linreg_n_coeffs (c) - 1);
777   std_error = sqrt (linreg_mse (c));
778   t = tab_create (n_cols, n_rows);
779   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, n_cols - 1, n_rows - 1);
780   tab_hline (t, TAL_2, 0, n_cols - 1, 1);
781   tab_vline (t, TAL_2, 2, 0, n_rows - 1);
782   tab_vline (t, TAL_0, 1, 0, 0);
783
784   tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("R"));
785   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("R Square"));
786   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Adjusted R Square"));
787   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("Std. Error of the Estimate"));
788   tab_double (t, 1, 1, TAB_RIGHT, sqrt (rsq), NULL, RC_OTHER);
789   tab_double (t, 2, 1, TAB_RIGHT, rsq, NULL, RC_OTHER);
790   tab_double (t, 3, 1, TAB_RIGHT, adjrsq, NULL, RC_OTHER);
791   tab_double (t, 4, 1, TAB_RIGHT, std_error, NULL, RC_OTHER);
792   tab_title (t, _("Model Summary (%s)"), var_to_string (var));
793   tab_submit (t);
794 }
795
796 /*
797   Table showing estimated regression coefficients.
798 */
799 static void
800 reg_stats_coeff (const linreg * c, const gsl_matrix *cov, const struct variable *var, const struct regression *cmd)
801 {
802   size_t j;
803   int n_cols = 7;
804   const int heading_rows = 2;
805   int n_rows;
806   int this_row;
807   double t_stat;
808   double pval;
809   double std_err;
810   double beta;
811   const char *label;
812
813   const struct variable *v;
814   struct tab_table *t;
815
816   const double df = linreg_n_obs (c) - linreg_n_coeffs (c) - 1;
817   double q = (1 - cmd->ci) / 2.0;  /* 2-tailed test */
818   double tval = gsl_cdf_tdist_Qinv (q, df);
819
820   assert (c != NULL);
821   n_rows = linreg_n_coeffs (c) + heading_rows + 1;
822
823   if (cmd->stats & STATS_CI)
824     n_cols += 2;
825
826   t = tab_create (n_cols, n_rows);
827   tab_headers (t, 2, 0, 1, 0);
828   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, n_cols - 1, n_rows - 1);
829   tab_hline (t, TAL_2, 0, n_cols - 1, heading_rows);
830   tab_vline (t, TAL_2, 2, 0, n_rows - 1);
831   tab_vline (t, TAL_0, 1, 0, 0);
832
833
834   tab_hline (t, TAL_1, 2, 4, 1); 
835   tab_joint_text (t, 2, 0, 3, 0, TAB_CENTER | TAT_TITLE, _("Unstandardized Coefficients"));
836   tab_text (t, 2, 1, TAB_CENTER | TAT_TITLE, _("B"));
837   tab_text (t, 3, 1, TAB_CENTER | TAT_TITLE, _("Std. Error"));
838   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("Standardized Coefficients"));
839   tab_text (t, 4, 1, TAB_CENTER | TAT_TITLE, _("Beta"));
840   tab_text (t, 5, 1, TAB_CENTER | TAT_TITLE, _("t"));
841   tab_text (t, 6, 1, TAB_CENTER | TAT_TITLE, _("Sig."));
842   tab_text (t, 1, heading_rows, TAB_LEFT | TAT_TITLE, _("(Constant)"));
843   tab_double (t, 2, heading_rows, 0, linreg_intercept (c), NULL, RC_OTHER);
844   std_err = sqrt (gsl_matrix_get (linreg_cov (c), 0, 0));
845
846   if (cmd->stats & STATS_CI)
847     {
848       double lower = linreg_intercept (c) - tval * std_err ;
849       double upper = linreg_intercept (c) + tval * std_err ;
850       tab_double (t, 7, heading_rows, 0, lower, NULL, RC_OTHER);
851       tab_double (t, 8, heading_rows, 0, upper, NULL, RC_OTHER);
852
853       tab_joint_text_format (t, 7, 0, 8, 0, TAB_CENTER | TAT_TITLE, _("%g%% Confidence Interval for B"), cmd->ci * 100);
854       tab_hline (t, TAL_1, 7, 8, 1); 
855       tab_text (t, 7, 1, TAB_CENTER | TAT_TITLE, _("Lower Bound"));
856       tab_text (t, 8, 1, TAB_CENTER | TAT_TITLE, _("Upper Bound"));
857     }
858   tab_double (t, 3, heading_rows, 0, std_err, NULL, RC_OTHER);
859   tab_double (t, 4, heading_rows, 0, 0.0, NULL, RC_OTHER);
860   t_stat = linreg_intercept (c) / std_err;
861   tab_double (t, 5, heading_rows, 0, t_stat, NULL, RC_OTHER);
862   pval =
863     2 * gsl_cdf_tdist_Q (fabs (t_stat),
864                          (double) (linreg_n_obs (c) - linreg_n_coeffs (c)));
865   tab_double (t, 6, heading_rows, 0, pval, NULL, RC_PVALUE);
866
867   for (j = 0; j < linreg_n_coeffs (c); j++)
868     {
869       struct string tstr;
870       ds_init_empty (&tstr);
871       this_row = j + heading_rows + 1;
872
873       v = linreg_indep_var (c, j);
874       label = var_to_string (v);
875       /* Do not overwrite the variable's name. */
876       ds_put_cstr (&tstr, label);
877       tab_text (t, 1, this_row, TAB_LEFT, ds_cstr (&tstr));
878       /*
879          Regression coefficients.
880        */
881       tab_double (t, 2, this_row, 0, linreg_coeff (c, j), NULL, RC_OTHER);
882       /*
883          Standard error of the coefficients.
884        */
885       std_err = sqrt (gsl_matrix_get (linreg_cov (c), j + 1, j + 1));
886       tab_double (t, 3, this_row, 0, std_err, NULL, RC_OTHER);
887       /*
888          Standardized coefficient, i.e., regression coefficient
889          if all variables had unit variance.
890        */
891       beta = sqrt (gsl_matrix_get (cov, j, j));
892       beta *= linreg_coeff (c, j) /
893         sqrt (gsl_matrix_get (cov, cov->size1 - 1, cov->size2 - 1));
894       tab_double (t, 4, this_row, 0, beta, NULL, RC_OTHER);
895
896       /*
897          Test statistic for H0: coefficient is 0.
898        */
899       t_stat = linreg_coeff (c, j) / std_err;
900       tab_double (t, 5, this_row, 0, t_stat, NULL, RC_OTHER);
901       /*
902          P values for the test statistic above.
903        */
904       pval = 2 * gsl_cdf_tdist_Q (fabs (t_stat), df);
905       tab_double (t, 6, this_row, 0, pval, NULL, RC_PVALUE);
906       ds_destroy (&tstr);
907
908       if (cmd->stats & STATS_CI)
909         {
910           double lower = linreg_coeff (c, j)  - tval * std_err ;
911           double upper = linreg_coeff (c, j)  + tval * std_err ;
912                         
913           tab_double (t, 7, this_row, 0, lower, NULL, RC_OTHER);
914           tab_double (t, 8, this_row, 0, upper, NULL, RC_OTHER);
915         }
916     }
917   tab_title (t, _("Coefficients (%s)"), var_to_string (var));
918   tab_submit (t);
919 }
920
921 /*
922   Display the ANOVA table.
923 */
924 static void
925 reg_stats_anova (const linreg * c, const struct variable *var)
926 {
927   int n_cols = 7;
928   int n_rows = 4;
929   const double msm = linreg_ssreg (c) / linreg_dfmodel (c);
930   const double mse = linreg_mse (c);
931   const double F = msm / mse;
932   const double pval = gsl_cdf_fdist_Q (F, c->dfm, c->dfe);
933
934   struct tab_table *t;
935
936   assert (c != NULL);
937   t = tab_create (n_cols, n_rows);
938   tab_headers (t, 2, 0, 1, 0);
939
940   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, n_cols - 1, n_rows - 1);
941
942   tab_hline (t, TAL_2, 0, n_cols - 1, 1);
943   tab_vline (t, TAL_2, 2, 0, n_rows - 1);
944   tab_vline (t, TAL_0, 1, 0, 0);
945
946   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Sum of Squares"));
947   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("df"));
948   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("Mean Square"));
949   tab_text (t, 5, 0, TAB_CENTER | TAT_TITLE, _("F"));
950   tab_text (t, 6, 0, TAB_CENTER | TAT_TITLE, _("Sig."));
951
952   tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Regression"));
953   tab_text (t, 1, 2, TAB_LEFT | TAT_TITLE, _("Residual"));
954   tab_text (t, 1, 3, TAB_LEFT | TAT_TITLE, _("Total"));
955
956   /* Sums of Squares */
957   tab_double (t, 2, 1, 0, linreg_ssreg (c), NULL, RC_OTHER);
958   tab_double (t, 2, 3, 0, linreg_sst (c), NULL, RC_OTHER);
959   tab_double (t, 2, 2, 0, linreg_sse (c), NULL, RC_OTHER);
960
961
962   /* Degrees of freedom */
963   tab_text_format (t, 3, 1, TAB_RIGHT, "%.*g", DBL_DIG + 1, c->dfm);
964   tab_text_format (t, 3, 2, TAB_RIGHT, "%.*g", DBL_DIG + 1, c->dfe);
965   tab_text_format (t, 3, 3, TAB_RIGHT, "%.*g", DBL_DIG + 1, c->dft);
966
967   /* Mean Squares */
968   tab_double (t, 4, 1, TAB_RIGHT, msm, NULL, RC_OTHER);
969   tab_double (t, 4, 2, TAB_RIGHT, mse, NULL, RC_OTHER);
970
971   tab_double (t, 5, 1, 0, F, NULL, RC_OTHER);
972
973   tab_double (t, 6, 1, 0, pval, NULL, RC_PVALUE);
974
975   tab_title (t, _("ANOVA (%s)"), var_to_string (var));
976   tab_submit (t);
977 }
978
979
980 static void
981 reg_stats_bcov (const linreg * c, const struct variable *var)
982 {
983   int n_cols;
984   int n_rows;
985   int i;
986   int k;
987   int row;
988   int col;
989   const char *label;
990   struct tab_table *t;
991
992   assert (c != NULL);
993   n_cols = c->n_indeps + 1 + 2;
994   n_rows = 2 * (c->n_indeps + 1);
995   t = tab_create (n_cols, n_rows);
996   tab_headers (t, 2, 0, 1, 0);
997   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, n_cols - 1, n_rows - 1);
998   tab_hline (t, TAL_2, 0, n_cols - 1, 1);
999   tab_vline (t, TAL_2, 2, 0, n_rows - 1);
1000   tab_vline (t, TAL_0, 1, 0, 0);
1001   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Model"));
1002   tab_text (t, 1, 1, TAB_CENTER | TAT_TITLE, _("Covariances"));
1003   for (i = 0; i < linreg_n_coeffs (c); i++)
1004     {
1005       const struct variable *v = linreg_indep_var (c, i);
1006       label = var_to_string (v);
1007       tab_text (t, 2, i, TAB_CENTER, label);
1008       tab_text (t, i + 2, 0, TAB_CENTER, label);
1009       for (k = 1; k < linreg_n_coeffs (c); k++)
1010         {
1011           col = (i <= k) ? k : i;
1012           row = (i <= k) ? i : k;
1013           tab_double (t, k + 2, i, TAB_CENTER,
1014                       gsl_matrix_get (c->cov, row, col), NULL, RC_OTHER);
1015         }
1016     }
1017   tab_title (t, _("Coefficient Correlations (%s)"), var_to_string (var));
1018   tab_submit (t);
1019 }
1020