nag_tabulate_margin (g11bcc) (PDF version)
g11 Chapter Contents
g11 Chapter Introduction
NAG C Library Manual

NAG Library Function Document

nag_tabulate_margin (g11bcc)

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

nag_tabulate_margin (g11bcc) computes a marginal table from a table computed by nag_tabulate_stats (g11bac) or nag_tabulate_percentile (g11bbc) using a selected statistic.

2  Specification

#include <nag.h>
#include <nagg11.h>
void  nag_tabulate_margin (Nag_TableStats stat, const double table[], Integer ncells, Integer ndim, const Integer idim[], const Integer isdim[], double sub_table[], Integer maxst, Integer *mcells, Integer *mdim, Integer mlevel[], double comm_ar[], NagError *fail)

3  Description

For a dataset containing classification variables (known as factors) the functions nag_tabulate_stats (g11bac) and nag_tabulate_percentile (g11bbc) compute a table using selected statistics, for example the mean or the median. The table is indexed by the levels of the selected factors, for example if there were three factors A, B and C with 3, 2 and 4 levels respectively and the mean was to be tabulated the resulting table would be 3×2×4 with each cell being the mean of all observations with the appropriate combination of levels of the three factors. In further analysis the table of means averaged over C for A and B may be required; this can be computed from the full table by taking the mean over the third dimension of the table, C.
In general, given a table computed by nag_tabulate_stats (g11bac) or nag_tabulate_percentile (g11bbc), nag_tabulate_margin (g11bcc) computes a sub-table defined by a subset of the factors used to define the table such that each cell of the sub-table is the selected statistic computed over the remaining factors. The statistics that can be used are the total, the mean, the median, the variance, the smallest and the largest value.

4  References

John J A and Quenouille M H (1977) Experiments: Design and Analysis Griffin
Kendall M G and Stuart A (1969) The Advanced Theory of Statistics (Volume 1) (3rd Edition) Griffin
West D H D (1979) Updating mean and variance estimates: An improved method Comm. ACM 22 532–555

5  Arguments

1:     statNag_TableStatsInput
On entry: indicates which statistic is to be used to compute the marginal table.
stat=Nag_TableStatsNObs
The total.
stat=Nag_TableStatsAv
The average or mean.
stat=Nag_TableStatsMedian
The median.
stat=Nag_TableStatsVar
The variance.
stat=Nag_TableStatsLarge
The largest value.
stat=Nag_TableStatsSmall
The smallest value.
Constraint: stat=Nag_TableStatsNObs, Nag_TableStatsAv, Nag_TableStatsMedian, Nag_TableStatsVar, Nag_TableStatsLarge or Nag_TableStatsSmall.
2:     table[ncells]const doubleInput
3:     ncellsIntegerInput
On entry: the number of cells in table as returned by nag_tabulate_stats (g11bac) or nag_tabulate_percentile (g11bbc).
4:     ndimIntegerInput
On entry: the number of dimensions for table as returned by nag_tabulate_stats (g11bac) or nag_tabulate_percentile (g11bbc).
Constraint: ndim2.
5:     idim[ndim]const IntegerInput
On entry: the number of levels for each dimension of table as returned by nag_tabulate_stats (g11bac) or nag_tabulate_percentile (g11bbc).
Constraint: idim[i]2, for i=0,1,,ndim-1.
6:     isdim[ndim]const IntegerInput
On entry: indicates which dimensions of table are to be included in the sub-table. If isdim[i-1]>0 the dimension or factor indicated by idim[i-1] is to be included in the sub-table, otherwise it is excluded.
7:     sub_table[maxst]doubleOutput
On exit: the first mcells elements contain the sub-table computed using the statistic indicated by stat. The table is stored in a similar way to table with the mcells cells stored so that for any two dimensions the index relating to the dimension given later in idim changes faster. For further details see Section 8.
8:     maxstIntegerInput
On entry: the maximum size of sub-table to be computed.
Constraint: maxst the product of the levels of the dimensions of table included in the sub-table, sub_table.
9:     mcellsInteger *Output
On exit: the number of cells in the sub-table in sub_table.
10:   mdimInteger *Output
On exit: the number of dimensions to the sub-table in sub_table.
11:   mlevel[ndim]IntegerOutput
On exit: the first mdim elements contain the number of levels for the dimensions of the sub-table in sub_table. The remaining elements are not referenced.
12:   comm_ar[dim]doubleOutput
Note: the dimension, dim, of the array comm_ar must be at least
  • maxst when stat=Nag_TableStatsVar;
  • 1 otherwise.
On exit: if stat=Nag_TableStatsVar comm_ar contains the sub-table of means corresponding to the sub-table of variances in sub_table. Otherwise comm_ar is not referenced.
13:   failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_INT
On entry, element value of idim1.
On entry, ndim=value.
Constraint: ndim2.
NE_INT_2
On entry, maxst (=value) is too small, min value =value.
On entry, ncells is incompatible with idim.
NE_INT_ARRAY_ELEM_CONS
On entry, all elements of isdim>0.
On entry, no elements of isdim>0.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.

7  Accuracy

Only applicable when stat=Nag_TableStatsVar. In this case a one pass algorithm is used as describe in West (1979).

8  Further Comments

The sub-tables created by nag_tabulate_margin (g11bcc) and stored in sub_table and, depending on stat, also in comm_ar are stored in the following way. Let there be m dimensions defining the table with dimension k having lk levels, then the cell defined by the levels i1,i2,,im of the factors is stored in sth cell given by
s=1+k=1mik-1ck,
where
cj=k=j+ 1m lk   for ​ j= 1, 2,, n- 1   and   cm=1.

9  Example

The data, given by John and Quenouille (1977), is for 3 blocks of a 3×6 factorial experiment. The data can be considered as a 3×6×3 table (i.e., blocks × treatment with 6 levels × treatment with 3 levels). This table is input and the 6×3 table of treatment means for over blocks is computed and printed.

9.1  Program Text

Program Text (g11bcce.c)

9.2  Program Data

Program Data (g11bcce.d)

9.3  Program Results

Program Results (g11bcce.r)


nag_tabulate_margin (g11bcc) (PDF version)
g11 Chapter Contents
g11 Chapter Introduction
NAG C Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2012