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