Fix ROC behaviour in the presence of missing values.
[pspp-builds.git] / src / language / stats / roc.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 "roc.h"
20 #include <data/procedure.h>
21 #include <language/lexer/variable-parser.h>
22 #include <language/lexer/value-parser.h>
23 #include <language/lexer/lexer.h>
24
25 #include <data/casegrouper.h>
26 #include <data/casereader.h>
27 #include <data/casewriter.h>
28 #include <data/dictionary.h>
29 #include <data/format.h>
30 #include <math/sort.h>
31 #include <data/subcase.h>
32
33
34 #include <libpspp/misc.h>
35
36 #include <gsl/gsl_cdf.h>
37 #include <output/table.h>
38
39 #include <output/charts/plot-chart.h>
40 #include <output/charts/cartesian.h>
41
42 #include "gettext.h"
43 #define _(msgid) gettext (msgid)
44 #define N_(msgid) msgid
45
46 struct cmd_roc
47 {
48   size_t n_vars;
49   const struct variable **vars;
50   const struct dictionary *dict;
51
52   struct variable *state_var ;
53   union value state_value;
54
55   /* Plot the roc curve */
56   bool curve;
57   /* Plot the reference line */
58   bool reference;
59
60   double ci;
61
62   bool print_coords;
63   bool print_se;
64   bool bi_neg_exp; /* True iff the bi-negative exponential critieria
65                       should be used */
66   enum mv_class exclude;
67
68   bool invert ; /* True iff a smaller test result variable indicates
69                    a positive result */
70
71   double pos;
72   double neg;
73   double pos_weighted;
74   double neg_weighted;
75 };
76
77 static int run_roc (struct dataset *ds, struct cmd_roc *roc);
78
79 int
80 cmd_roc (struct lexer *lexer, struct dataset *ds)
81 {
82   struct cmd_roc roc ;
83   const struct dictionary *dict = dataset_dict (ds);
84
85   roc.vars = NULL;
86   roc.n_vars = 0;
87   roc.print_se = false;
88   roc.print_coords = false;
89   roc.exclude = MV_ANY;
90   roc.curve = true;
91   roc.reference = false;
92   roc.ci = 95;
93   roc.bi_neg_exp = false;
94   roc.invert = false;
95   roc.pos = roc.pos_weighted = 0;
96   roc.neg = roc.neg_weighted = 0;
97   roc.dict = dataset_dict (ds);
98
99   if (!parse_variables_const (lexer, dict, &roc.vars, &roc.n_vars,
100                               PV_APPEND | PV_NO_DUPLICATE | PV_NUMERIC))
101     return 2;
102
103   if ( ! lex_force_match (lexer, T_BY))
104     {
105       return 2;
106     }
107
108   roc.state_var = parse_variable (lexer, dict);
109
110   if ( !lex_force_match (lexer, '('))
111     {
112       return 2;
113     }
114
115   parse_value (lexer, &roc.state_value, var_get_width (roc.state_var));
116
117
118   if ( !lex_force_match (lexer, ')'))
119     {
120       return 2;
121     }
122
123
124   while (lex_token (lexer) != '.')
125     {
126       lex_match (lexer, '/');
127       if (lex_match_id (lexer, "MISSING"))
128         {
129           lex_match (lexer, '=');
130           while (lex_token (lexer) != '.' && lex_token (lexer) != '/')
131             {
132               if (lex_match_id (lexer, "INCLUDE"))
133                 {
134                   roc.exclude = MV_SYSTEM;
135                 }
136               else if (lex_match_id (lexer, "EXCLUDE"))
137                 {
138                   roc.exclude = MV_ANY;
139                 }
140               else
141                 {
142                   lex_error (lexer, NULL);
143                   return 2;
144                 }
145             }
146         }
147       else if (lex_match_id (lexer, "PLOT"))
148         {
149           lex_match (lexer, '=');
150           if (lex_match_id (lexer, "CURVE"))
151             {
152               roc.curve = true;
153               if (lex_match (lexer, '('))
154                 {
155                   roc.reference = true;
156                   lex_force_match_id (lexer, "REFERENCE");
157                   lex_force_match (lexer, ')');
158                 }
159             }
160           else if (lex_match_id (lexer, "NONE"))
161             {
162               roc.curve = false;
163             }
164           else
165             {
166               lex_error (lexer, NULL);
167               return 2;
168             }
169         }
170       else if (lex_match_id (lexer, "PRINT"))
171         {
172           lex_match (lexer, '=');
173           while (lex_token (lexer) != '.' && lex_token (lexer) != '/')
174             {
175               if (lex_match_id (lexer, "SE"))
176                 {
177                   roc.print_se = true;
178                 }
179               else if (lex_match_id (lexer, "COORDINATES"))
180                 {
181                   roc.print_coords = true;
182                 }
183               else
184                 {
185                   lex_error (lexer, NULL);
186                   return 2;
187                 }
188             }
189         }
190       else if (lex_match_id (lexer, "CRITERIA"))
191         {
192           lex_match (lexer, '=');
193           while (lex_token (lexer) != '.' && lex_token (lexer) != '/')
194             {
195               if (lex_match_id (lexer, "CUTOFF"))
196                 {
197                   lex_force_match (lexer, '(');
198                   if (lex_match_id (lexer, "INCLUDE"))
199                     {
200                       roc.exclude = MV_SYSTEM;
201                     }
202                   else if (lex_match_id (lexer, "EXCLUDE"))
203                     {
204                       roc.exclude = MV_USER | MV_SYSTEM;
205                     }
206                   else
207                     {
208                       lex_error (lexer, NULL);
209                       return 2;
210                     }
211                   lex_force_match (lexer, ')');
212                 }
213               else if (lex_match_id (lexer, "TESTPOS"))
214                 {
215                   lex_force_match (lexer, '(');
216                   if (lex_match_id (lexer, "LARGE"))
217                     {
218                       roc.invert = false;
219                     }
220                   else if (lex_match_id (lexer, "SMALL"))
221                     {
222                       roc.invert = true;
223                     }
224                   else
225                     {
226                       lex_error (lexer, NULL);
227                       return 2;
228                     }
229                   lex_force_match (lexer, ')');
230                 }
231               else if (lex_match_id (lexer, "CI"))
232                 {
233                   lex_force_match (lexer, '(');
234                   lex_force_num (lexer);
235                   roc.ci = lex_number (lexer);
236                   lex_get (lexer);
237                   lex_force_match (lexer, ')');
238                 }
239               else if (lex_match_id (lexer, "DISTRIBUTION"))
240                 {
241                   lex_force_match (lexer, '(');
242                   if (lex_match_id (lexer, "FREE"))
243                     {
244                       roc.bi_neg_exp = false;
245                     }
246                   else if (lex_match_id (lexer, "NEGEXPO"))
247                     {
248                       roc.bi_neg_exp = true;
249                     }
250                   else
251                     {
252                       lex_error (lexer, NULL);
253                       return 2;
254                     }
255                   lex_force_match (lexer, ')');
256                 }
257               else
258                 {
259                   lex_error (lexer, NULL);
260                   return 2;
261                 }
262             }
263         }
264       else
265         {
266           lex_error (lexer, NULL);
267           break;
268         }
269     }
270
271   run_roc (ds, &roc);
272
273   return 1;
274 }
275
276
277
278
279 static void
280 do_roc (struct cmd_roc *roc, struct casereader *group, struct dictionary *dict);
281
282
283 static int
284 run_roc (struct dataset *ds, struct cmd_roc *roc)
285 {
286   struct dictionary *dict = dataset_dict (ds);
287   bool ok;
288   struct casereader *group;
289
290   struct casegrouper *grouper = casegrouper_create_splits (proc_open (ds), dict);
291   while (casegrouper_get_next_group (grouper, &group))
292     {
293       do_roc (roc, group, dataset_dict (ds));
294     }
295   ok = casegrouper_destroy (grouper);
296   ok = proc_commit (ds) && ok;
297
298   return ok;
299 }
300
301 #if 0
302 static void
303 dump_casereader (struct casereader *reader)
304 {
305   struct ccase *c;
306   struct casereader *r = casereader_clone (reader);
307
308   for ( ; (c = casereader_read (r) ); case_unref (c))
309     {
310       int i;
311       for (i = 0 ; i < case_get_value_cnt (c); ++i)
312         {
313           printf ("%g ", case_data_idx (c, i)->f);
314         }
315       printf ("\n");
316     }
317
318   casereader_destroy (r);
319 }
320 #endif
321
322 static bool
323 match_positives (const struct ccase *c, void *aux)
324 {
325   struct cmd_roc *roc = aux;
326   const struct variable *wv = dict_get_weight (roc->dict);
327   const double weight = wv ? case_data (c, wv)->f : 1.0;
328
329   bool positive = ( 0 == value_compare_3way (case_data (c, roc->state_var),
330                                   &roc->state_value,
331                                              var_get_width (roc->state_var)));
332
333   if ( positive )
334     {
335       roc->pos++;
336       roc->pos_weighted += weight;
337     }
338   else
339     {
340       roc->neg++;
341       roc->neg_weighted += weight;
342     }
343
344   return positive;
345 }
346
347
348 #define VALUE  0
349 #define N_EQ   1
350 #define N_PRED 2
351
352 struct roc_state
353 {
354   double auc;
355
356   double n1;
357   double n2;
358
359   double q1hat;
360   double q2hat;
361
362   struct casewriter *cutpoint_wtr;
363   struct casereader *cutpoint_rdr;
364   double prev_result;
365   double min;
366   double max;
367 };
368
369
370
371 #define CUTPOINT 0
372 #define TP 1
373 #define FN 2
374 #define TN 3
375 #define FP 4
376
377
378 static struct casereader *
379 accumulate_counts (struct casereader *cutpoint_rdr, 
380                    double result, double weight, 
381                    bool (*pos_cond) (double, double),
382                    int true_index, int false_index)
383 {
384   const struct caseproto *proto = casereader_get_proto (cutpoint_rdr);
385   struct casewriter *w =
386     autopaging_writer_create (proto);
387   struct casereader *r = casereader_clone (cutpoint_rdr);
388   struct ccase *cpc;
389   double prev_cp = SYSMIS;
390
391
392   for ( ; (cpc = casereader_read (r) ); case_unref (cpc))
393     {
394       struct ccase *new_case;
395       const double cp = case_data_idx (cpc, CUTPOINT)->f;
396
397       /* We don't want duplicates here */
398       if ( cp == prev_cp )
399         continue;
400
401       new_case = case_clone (cpc);
402
403       if ( pos_cond (result, cp))
404         {
405           case_data_rw_idx (new_case, true_index)->f += weight;
406         }
407       else
408         {
409           case_data_rw_idx (new_case, false_index)->f += weight;
410         }
411
412       prev_cp = cp;
413
414       casewriter_write (w, new_case);
415     }
416   casereader_destroy (r);
417
418   return casewriter_make_reader (w);
419 }
420
421
422
423 static void output_roc (struct roc_state *rs, const struct cmd_roc *roc);
424
425
426 static struct casereader *
427 process_group (const struct variable *var, struct casereader *reader,
428                bool (*pred) (double, double),
429                const struct dictionary *dict,
430                double *cc,
431                struct casereader **cutpoint_rdr, 
432                bool (*pos_cond) (double, double),
433                int true_index,
434                int false_index)
435 {
436   const struct variable *w = dict_get_weight (dict);
437
438   struct casereader *r1 =
439     casereader_create_distinct (sort_execute_1var (reader, var), var, w);
440
441   const int weight_idx  = w ? var_get_case_index (w) :
442     caseproto_get_n_widths (casereader_get_proto (r1)) - 1;
443   
444   struct ccase *c1;
445
446   struct casereader *rclone = casereader_clone (r1);
447   struct casewriter *wtr;
448   struct caseproto *proto = caseproto_create ();
449
450   proto = caseproto_add_width (proto, 0);
451   proto = caseproto_add_width (proto, 0);
452   proto = caseproto_add_width (proto, 0);
453
454   wtr = autopaging_writer_create (proto);  
455
456   *cc = 0;
457
458   for ( ; (c1 = casereader_read (r1) ); case_unref (c1))
459     {
460       struct ccase *new_case = case_create (proto);
461       struct ccase *c2;
462       struct casereader *r2 = casereader_clone (rclone);
463
464       const double weight1 = case_data_idx (c1, weight_idx)->f;
465       const double d1 = case_data (c1, var)->f;
466       double n_eq = 0.0;
467       double n_pred = 0.0;
468
469       *cutpoint_rdr = accumulate_counts (*cutpoint_rdr, d1, weight1,
470                                          pos_cond,
471                                          true_index, false_index);
472
473       *cc += weight1;
474
475       for ( ; (c2 = casereader_read (r2) ); case_unref (c2))
476         {
477           const double d2 = case_data (c2, var)->f;
478           const double weight2 = case_data_idx (c2, weight_idx)->f;
479
480           if ( d1 == d2 )
481             {
482               n_eq += weight2;
483               continue;
484             }
485           else  if ( pred (d2, d1))
486             {
487               n_pred += weight2;
488             }
489         }
490
491       case_data_rw_idx (new_case, VALUE)->f = d1;
492       case_data_rw_idx (new_case, N_EQ)->f = n_eq;
493       case_data_rw_idx (new_case, N_PRED)->f = n_pred;
494
495       casewriter_write (wtr, new_case);
496
497       casereader_destroy (r2);
498     }
499
500   casereader_destroy (r1);
501   casereader_destroy (rclone);
502
503   return casewriter_make_reader (wtr);
504 }
505
506 static bool
507 gt (double d1, double d2)
508 {
509   return d1 > d2;
510 }
511
512
513 static bool
514 ge (double d1, double d2)
515 {
516   return d1 > d2;
517 }
518
519 static bool
520 lt (double d1, double d2)
521 {
522   return d1 < d2;
523 }
524
525 static struct casereader *
526 process_positive_group (const struct variable *var, struct casereader *reader,
527                         const struct dictionary *dict,
528                         struct roc_state *rs)
529 {
530   return process_group (var, reader, gt, dict, &rs->n1,
531                         &rs->cutpoint_rdr,
532                         ge,
533                         TP, FN);
534 }
535
536
537 static struct casereader *
538 process_negative_group (const struct variable *var, struct casereader *reader,
539                         const struct dictionary *dict,
540                         struct roc_state *rs)
541 {
542   return process_group (var, reader, lt, dict, &rs->n2,
543                         &rs->cutpoint_rdr,
544                         lt,
545                         TN, FP);
546 }
547
548
549
550
551 static void
552 append_cutpoint (struct casewriter *writer, double cutpoint)
553 {
554   struct ccase *cc = case_create (casewriter_get_proto (writer));
555
556   case_data_rw_idx (cc, CUTPOINT)->f = cutpoint;
557   case_data_rw_idx (cc, TP)->f = 0;
558   case_data_rw_idx (cc, FN)->f = 0;
559   case_data_rw_idx (cc, TN)->f = 0;
560   case_data_rw_idx (cc, FP)->f = 0;
561
562
563   casewriter_write (writer, cc);
564 }
565
566
567 /* Prepare the cutpoints */
568 static void
569 prepare_cutpoints (struct cmd_roc *roc, struct roc_state *rs, struct casereader *input)
570 {
571   int i;
572   struct casereader *r = casereader_clone (input);
573   struct ccase *c;
574   struct caseproto *proto = caseproto_create ();
575
576   struct subcase ordering;
577   subcase_init (&ordering, CUTPOINT, 0, SC_ASCEND);
578
579   proto = caseproto_add_width (proto, 0); /* cutpoint */
580   proto = caseproto_add_width (proto, 0); /* TP */
581   proto = caseproto_add_width (proto, 0); /* FN */
582   proto = caseproto_add_width (proto, 0); /* TN */
583   proto = caseproto_add_width (proto, 0); /* FP */
584
585   for (i = 0 ; i < roc->n_vars; ++i)
586     {
587       rs[i].cutpoint_wtr = sort_create_writer (&ordering, proto);
588       rs[i].prev_result = SYSMIS;
589       rs[i].max = -DBL_MAX;
590       rs[i].min = DBL_MAX;
591     }
592
593   for (; (c = casereader_read (r)) != NULL; case_unref (c))
594     {
595       for (i = 0 ; i < roc->n_vars; ++i)
596         {
597           const union value *v = case_data (c, roc->vars[i]); 
598           const double result = v->f;
599
600           if ( mv_is_value_missing (var_get_missing_values (roc->vars[i]), v, roc->exclude))
601             continue;
602
603           minimize (&rs[i].min, result);
604           maximize (&rs[i].max, result);
605
606           if ( rs[i].prev_result != SYSMIS && rs[i].prev_result != result )
607             {
608               const double mean = (result + rs[i].prev_result ) / 2.0;
609               append_cutpoint (rs[i].cutpoint_wtr, mean);
610             }
611
612           rs[i].prev_result = result;
613         }
614     }
615   casereader_destroy (r);
616
617
618   /* Append the min and max cutpoints */
619   for (i = 0 ; i < roc->n_vars; ++i)
620     {
621       append_cutpoint (rs[i].cutpoint_wtr, rs[i].min - 1);
622       append_cutpoint (rs[i].cutpoint_wtr, rs[i].max + 1);
623
624       rs[i].cutpoint_rdr = casewriter_make_reader (rs[i].cutpoint_wtr);
625     }
626 }
627
628 static void
629 do_roc (struct cmd_roc *roc, struct casereader *reader, struct dictionary *dict)
630 {
631   int i;
632
633   struct roc_state *rs = xcalloc (roc->n_vars, sizeof *rs);
634
635   struct casereader *negatives = NULL;
636   struct casereader *positives = NULL;
637
638   struct caseproto *n_proto = caseproto_create ();
639
640   struct subcase up_ordering;
641   struct subcase down_ordering;
642
643   struct casereader *input = casereader_create_filter_missing (reader,
644                                                                roc->vars, roc->n_vars,
645                                                                roc->exclude,
646                                                                NULL,
647                                                                NULL);
648
649
650   struct casewriter *neg_wtr = autopaging_writer_create (casereader_get_proto (input));
651
652   prepare_cutpoints (roc, rs, input);
653
654   positives = 
655     casereader_create_filter_func (input,
656                                    match_positives,
657                                    NULL,
658                                    roc,
659                                    neg_wtr);
660
661   n_proto = caseproto_create ();
662       
663   n_proto = caseproto_add_width (n_proto, 0);
664   n_proto = caseproto_add_width (n_proto, 0);
665   n_proto = caseproto_add_width (n_proto, 0);
666   n_proto = caseproto_add_width (n_proto, 0);
667   n_proto = caseproto_add_width (n_proto, 0);
668
669   subcase_init (&up_ordering, VALUE, 0, SC_ASCEND);
670   subcase_init (&down_ordering, VALUE, 0, SC_DESCEND);
671
672   for (i = 0 ; i < roc->n_vars; ++i)
673     {
674       struct casewriter *w = NULL;
675       struct casereader *r = NULL;
676
677       struct ccase *c;
678
679       struct ccase *cpos;
680       struct casereader *n_neg ;
681       const struct variable *var = roc->vars[i];
682
683       struct casereader *neg ;
684       struct casereader *pos = casereader_clone (positives);
685
686       struct casereader *n_pos =
687         process_positive_group (var, pos, dict, &rs[i]);
688
689       if ( negatives == NULL)
690         {
691           negatives = casewriter_make_reader (neg_wtr);
692         }
693
694       neg = casereader_clone (negatives);
695
696       n_neg = process_negative_group (var, neg, dict, &rs[i]);
697
698       w = sort_create_writer (&up_ordering, n_proto);
699       for ( ; (cpos = casereader_read (n_pos) ); case_unref (cpos))
700         {
701           struct ccase *pos_case = case_create (n_proto);
702           struct ccase *cneg;
703           const double jpos = case_data_idx (cpos, VALUE)->f;
704
705           while ((cneg = casereader_read (n_neg)))
706             {
707               struct ccase *nc = case_create (n_proto);
708
709               const double jneg = case_data_idx (cneg, VALUE)->f;
710
711               case_data_rw_idx (nc, VALUE)->f = jneg;
712               case_data_rw_idx (nc, N_EQ)->f = 0;
713
714               case_data_rw_idx (nc, N_PRED)->f = SYSMIS;
715
716               *case_data_rw_idx (nc, 3) = *case_data_idx (cneg, N_EQ);
717               *case_data_rw_idx (nc, 4) = *case_data_idx (cneg, N_PRED);
718
719               casewriter_write (w, nc);
720
721               case_unref (cneg);
722               if ( jneg > jpos)
723                 break;
724             }
725
726           case_data_rw_idx (pos_case, VALUE)->f = jpos;
727           *case_data_rw_idx (pos_case, N_EQ) = *case_data_idx (cpos, N_EQ);
728           *case_data_rw_idx (pos_case, N_PRED) = *case_data_idx (cpos, N_PRED);
729           case_data_rw_idx (pos_case, 3)->f = 0;
730           case_data_rw_idx (pos_case, 4)->f = SYSMIS;
731
732           casewriter_write (w, pos_case);
733         }
734
735       r = casewriter_make_reader (w);
736
737       {
738         double prev_pos_gt = rs[i].n1;
739         w = sort_create_writer (&down_ordering, n_proto);
740
741         for ( ; (c = casereader_read (r) ); case_unref (c))
742           {
743             double n_pos_gt = case_data_idx (c, N_PRED)->f;
744             struct ccase *nc = case_clone (c);
745
746             if ( n_pos_gt == SYSMIS)
747               {
748                 n_pos_gt = prev_pos_gt;
749                 case_data_rw_idx (nc, N_PRED)->f = n_pos_gt;
750               }
751             
752             casewriter_write (w, nc);
753             prev_pos_gt = n_pos_gt;
754           }
755
756         r = casewriter_make_reader (w);
757       }
758
759       {
760         double prev_neg_lt = rs[i].n2;
761         w = sort_create_writer (&up_ordering, n_proto);
762
763         for ( ; (c = casereader_read (r) ); case_unref (c))
764           {
765             double n_neg_lt = case_data_idx (c, 4)->f;
766             struct ccase *nc = case_clone (c);
767
768             if ( n_neg_lt == SYSMIS)
769               {
770                 n_neg_lt = prev_neg_lt;
771                 case_data_rw_idx (nc, 4)->f = n_neg_lt;
772               }
773             
774             casewriter_write (w, nc);
775             prev_neg_lt = n_neg_lt;
776           }
777
778         r = casewriter_make_reader (w);
779       }
780
781       {
782         struct ccase *prev_case = NULL;
783         for ( ; (c = casereader_read (r) ); case_unref (c))
784           {
785             const struct ccase *next_case = casereader_peek (r, 0);
786
787             const double j = case_data_idx (c, VALUE)->f;
788             double n_pos_eq = case_data_idx (c, N_EQ)->f;
789             double n_pos_gt = case_data_idx (c, N_PRED)->f;
790             double n_neg_eq = case_data_idx (c, 3)->f;
791             double n_neg_lt = case_data_idx (c, 4)->f;
792
793             if ( prev_case && j == case_data_idx (prev_case, VALUE)->f)
794               {
795                 if ( 0 ==  case_data_idx (c, N_EQ)->f)
796                   {
797                     n_pos_eq = case_data_idx (prev_case, N_EQ)->f;
798                     n_pos_gt = case_data_idx (prev_case, N_PRED)->f;
799                   }
800
801                 if ( 0 ==  case_data_idx (c, 3)->f)
802                   {
803                     n_neg_eq = case_data_idx (prev_case, 3)->f;
804                     n_neg_lt = case_data_idx (prev_case, 4)->f;
805                   }
806               }
807
808             if ( NULL == next_case || j != case_data_idx (next_case, VALUE)->f)
809               {
810                 rs[i].auc += n_pos_gt * n_neg_eq + (n_pos_eq * n_neg_eq) / 2.0;
811
812                 rs[i].q1hat +=
813                   n_neg_eq * ( pow2 (n_pos_gt) + n_pos_gt * n_pos_eq + pow2 (n_pos_eq) / 3.0);
814                 rs[i].q2hat +=
815                   n_pos_eq * ( pow2 (n_neg_lt) + n_neg_lt * n_neg_eq + pow2 (n_neg_eq) / 3.0);
816
817               }
818
819             case_unref (prev_case);
820             prev_case = case_clone (c);
821           }
822
823         rs[i].auc /=  rs[i].n1 * rs[i].n2; 
824         if ( roc->invert ) 
825           rs[i].auc = 1 - rs[i].auc;
826
827         if ( roc->bi_neg_exp )
828           {
829             rs[i].q1hat = rs[i].auc / ( 2 - rs[i].auc);
830             rs[i].q2hat = 2 * pow2 (rs[i].auc) / ( 1 + rs[i].auc);
831           }
832         else
833           {
834             rs[i].q1hat /= rs[i].n2 * pow2 (rs[i].n1);
835             rs[i].q2hat /= rs[i].n1 * pow2 (rs[i].n2);
836           }
837       }
838     }
839
840   casereader_destroy (positives);
841   casereader_destroy (negatives);
842
843   output_roc (rs, roc);
844
845   free (rs);
846 }
847
848 static void
849 show_auc  (struct roc_state *rs, const struct cmd_roc *roc)
850 {
851   int i;
852   const int n_fields = roc->print_se ? 5 : 1;
853   const int n_cols = roc->n_vars > 1 ? n_fields + 1: n_fields;
854   const int n_rows = 2 + roc->n_vars;
855   struct tab_table *tbl = tab_create (n_cols, n_rows, 0);
856
857   if ( roc->n_vars > 1)
858     tab_title (tbl, _("Area Under the Curve"));
859   else
860     tab_title (tbl, _("Area Under the Curve (%s)"), var_to_string (roc->vars[0]));
861
862   tab_headers (tbl, n_cols - n_fields, 0, 1, 0);
863
864   tab_dim (tbl, tab_natural_dimensions, NULL);
865
866   tab_text (tbl, n_cols - n_fields, 1, TAT_TITLE, _("Area"));
867
868   tab_hline (tbl, TAL_2, 0, n_cols - 1, 2);
869
870   tab_box (tbl,
871            TAL_2, TAL_2,
872            -1, TAL_1,
873            0, 0,
874            n_cols - 1,
875            n_rows - 1);
876
877   if ( roc->print_se )
878     {
879       tab_text (tbl, n_cols - 4, 1, TAT_TITLE, _("Std. Error"));
880       tab_text (tbl, n_cols - 3, 1, TAT_TITLE, _("Asymptotic Sig."));
881
882       tab_text (tbl, n_cols - 2, 1, TAT_TITLE, _("Lower Bound"));
883       tab_text (tbl, n_cols - 1, 1, TAT_TITLE, _("Upper Bound"));
884
885       tab_joint_text (tbl, n_cols - 2, 0, 4, 0,
886                       TAT_TITLE | TAB_CENTER | TAT_PRINTF,
887                       _("Asymp. %g%% Confidence Interval"), roc->ci);
888       tab_vline (tbl, 0, n_cols - 1, 0, 0);
889       tab_hline (tbl, TAL_1, n_cols - 2, n_cols - 1, 1);
890     }
891
892   if ( roc->n_vars > 1)
893     tab_text (tbl, 0, 1, TAT_TITLE, _("Variable under test"));
894
895   if ( roc->n_vars > 1)
896     tab_vline (tbl, TAL_2, 1, 0, n_rows - 1);
897
898
899   for ( i = 0 ; i < roc->n_vars ; ++i )
900     {
901       tab_text (tbl, 0, 2 + i, TAT_TITLE, var_to_string (roc->vars[i]));
902
903       tab_double (tbl, n_cols - n_fields, 2 + i, 0, rs[i].auc, NULL);
904
905       if ( roc->print_se )
906         {
907           double se ;
908           const double sd_0_5 = sqrt ((rs[i].n1 + rs[i].n2 + 1) /
909                                       (12 * rs[i].n1 * rs[i].n2));
910           double ci ;
911           double yy ;
912
913           se = rs[i].auc * (1 - rs[i].auc) + (rs[i].n1 - 1) * (rs[i].q1hat - pow2 (rs[i].auc)) +
914             (rs[i].n2 - 1) * (rs[i].q2hat - pow2 (rs[i].auc));
915
916           se /= rs[i].n1 * rs[i].n2;
917
918           se = sqrt (se);
919
920           tab_double (tbl, n_cols - 4, 2 + i, 0,
921                       se,
922                       NULL);
923
924           ci = 1 - roc->ci / 100.0;
925           yy = gsl_cdf_gaussian_Qinv (ci, se) ;
926
927           tab_double (tbl, n_cols - 2, 2 + i, 0,
928                       rs[i].auc - yy,
929                       NULL);
930
931           tab_double (tbl, n_cols - 1, 2 + i, 0,
932                       rs[i].auc + yy,
933                       NULL);
934
935           tab_double (tbl, n_cols - 3, 2 + i, 0,
936                       2.0 * gsl_cdf_ugaussian_Q (fabs ((rs[i].auc - 0.5 ) / sd_0_5)),
937                       NULL);
938         }
939     }
940
941   tab_submit (tbl);
942 }
943
944
945 static void
946 show_summary (const struct cmd_roc *roc)
947 {
948   const int n_cols = 3;
949   const int n_rows = 4;
950   struct tab_table *tbl = tab_create (n_cols, n_rows, 0);
951
952   tab_title (tbl, _("Case Summary"));
953
954   tab_headers (tbl, 1, 0, 2, 0);
955
956   tab_dim (tbl, tab_natural_dimensions, NULL);
957
958   tab_box (tbl,
959            TAL_2, TAL_2,
960            -1, -1,
961            0, 0,
962            n_cols - 1,
963            n_rows - 1);
964
965   tab_hline (tbl, TAL_2, 0, n_cols - 1, 2);
966   tab_vline (tbl, TAL_2, 1, 0, n_rows - 1);
967
968
969   tab_hline (tbl, TAL_2, 1, n_cols - 1, 1);
970   tab_vline (tbl, TAL_1, 2, 1, n_rows - 1);
971
972
973   tab_text (tbl, 0, 1, TAT_TITLE | TAB_LEFT, var_to_string (roc->state_var));
974   tab_text (tbl, 1, 1, TAT_TITLE, _("Unweighted"));
975   tab_text (tbl, 2, 1, TAT_TITLE, _("Weighted"));
976
977   tab_joint_text (tbl, 1, 0, 2, 0,
978                   TAT_TITLE | TAB_CENTER,
979                   _("Valid N (listwise)"));
980
981
982   tab_text (tbl, 0, 2, TAB_LEFT, _("Positive"));
983   tab_text (tbl, 0, 3, TAB_LEFT, _("Negative"));
984
985
986   tab_double (tbl, 1, 2, 0, roc->pos, &F_8_0);
987   tab_double (tbl, 1, 3, 0, roc->neg, &F_8_0);
988
989   tab_double (tbl, 2, 2, 0, roc->pos_weighted, 0);
990   tab_double (tbl, 2, 3, 0, roc->neg_weighted, 0);
991
992   tab_submit (tbl);
993 }
994
995
996 static void
997 show_coords (struct roc_state *rs, const struct cmd_roc *roc)
998 {
999   int x = 1;
1000   int i;
1001   const int n_cols = roc->n_vars > 1 ? 4 : 3;
1002   int n_rows = 1;
1003   struct tab_table *tbl ;
1004
1005   for (i = 0; i < roc->n_vars; ++i)
1006     n_rows += casereader_count_cases (rs[i].cutpoint_rdr);
1007
1008   tbl = tab_create (n_cols, n_rows, 0);
1009
1010   if ( roc->n_vars > 1)
1011     tab_title (tbl, _("Coordinates of the Curve"));
1012   else
1013     tab_title (tbl, _("Coordinates of the Curve (%s)"), var_to_string (roc->vars[0]));
1014
1015
1016   tab_headers (tbl, 1, 0, 1, 0);
1017
1018   tab_dim (tbl, tab_natural_dimensions, NULL);
1019
1020   tab_hline (tbl, TAL_2, 0, n_cols - 1, 1);
1021
1022   if ( roc->n_vars > 1)
1023     tab_text (tbl, 0, 0, TAT_TITLE, _("Test variable"));
1024
1025   tab_text (tbl, n_cols - 3, 0, TAT_TITLE, _("Positive if greater than or equal to"));
1026   tab_text (tbl, n_cols - 2, 0, TAT_TITLE, _("Sensitivity"));
1027   tab_text (tbl, n_cols - 1, 0, TAT_TITLE, _("1 - Specificity"));
1028
1029   tab_box (tbl,
1030            TAL_2, TAL_2,
1031            -1, TAL_1,
1032            0, 0,
1033            n_cols - 1,
1034            n_rows - 1);
1035
1036   if ( roc->n_vars > 1)
1037     tab_vline (tbl, TAL_2, 1, 0, n_rows - 1);
1038
1039   for (i = 0; i < roc->n_vars; ++i)
1040     {
1041       struct ccase *cc;
1042       struct casereader *r = casereader_clone (rs[i].cutpoint_rdr);
1043
1044       if ( roc->n_vars > 1)
1045         tab_text (tbl, 0, x, TAT_TITLE, var_to_string (roc->vars[i]));
1046
1047       if ( i > 0)
1048         tab_hline (tbl, TAL_1, 0, n_cols - 1, x);
1049
1050
1051       for (; (cc = casereader_read (r)) != NULL;
1052            case_unref (cc), x++)
1053         {
1054           const double se = case_data_idx (cc, TP)->f /
1055             (
1056              case_data_idx (cc, TP)->f
1057              +
1058              case_data_idx (cc, FN)->f
1059              );
1060
1061           const double sp = case_data_idx (cc, TN)->f /
1062             (
1063              case_data_idx (cc, TN)->f
1064              +
1065              case_data_idx (cc, FP)->f
1066              );
1067
1068           tab_double (tbl, n_cols - 3, x, 0, case_data_idx (cc, CUTPOINT)->f,
1069                       var_get_print_format (roc->vars[i]));
1070
1071           tab_double (tbl, n_cols - 2, x, 0, se, NULL);
1072           tab_double (tbl, n_cols - 1, x, 0, 1 - sp, NULL);
1073         }
1074
1075       casereader_destroy (r);
1076     }
1077
1078   tab_submit (tbl);
1079 }
1080
1081
1082 static void
1083 draw_roc (struct roc_state *rs, const struct cmd_roc *roc)
1084 {
1085   int i;
1086
1087   struct chart *roc_chart = chart_create ();
1088
1089   chart_write_title (roc_chart, _("ROC Curve"));
1090   chart_write_xlabel (roc_chart, _("1 - Specificity"));
1091   chart_write_ylabel (roc_chart, _("Sensitivity"));
1092
1093   chart_write_xscale (roc_chart, 0, 1, 5);
1094   chart_write_yscale (roc_chart, 0, 1, 5);
1095
1096   if ( roc->reference )
1097     {
1098       chart_line (roc_chart, 1.0, 0,
1099                   0.0, 1.0,
1100                   CHART_DIM_X);
1101     }
1102
1103   for (i = 0; i < roc->n_vars; ++i)
1104     {
1105       struct ccase *cc;
1106       struct casereader *r = casereader_clone (rs[i].cutpoint_rdr);
1107
1108       chart_vector_start (roc_chart, var_get_name (roc->vars[i]));
1109       for (; (cc = casereader_read (r)) != NULL;
1110            case_unref (cc))
1111         {
1112           double se = case_data_idx (cc, TP)->f;
1113           double sp = case_data_idx (cc, TN)->f;
1114
1115           se /= case_data_idx (cc, FN)->f +
1116             case_data_idx (cc, TP)->f ;
1117
1118           sp /= case_data_idx (cc, TN)->f +
1119             case_data_idx (cc, FP)->f ;
1120
1121           chart_vector (roc_chart, 1 - sp, se);
1122         }
1123       chart_vector_end (roc_chart);
1124       casereader_destroy (r);
1125     }
1126
1127   chart_write_legend (roc_chart);
1128
1129   chart_submit (roc_chart);
1130 }
1131
1132
1133 static void
1134 output_roc (struct roc_state *rs, const struct cmd_roc *roc)
1135 {
1136   show_summary (roc);
1137
1138   if ( roc->curve )
1139     draw_roc (rs, roc);
1140
1141   show_auc (rs, roc);
1142
1143
1144   if ( roc->print_coords )
1145     show_coords (rs, roc);
1146 }
1147