naginterfaces.library.anova.dummyvars

naginterfaces.library.anova.dummyvars(typ, levels, ifact, v)

dummyvars computes orthogonal polynomial or dummy variables for a factor or classification variable.

For full information please refer to the NAG Library document for g04ea

https://support.nag.com/numeric/nl/nagdoc_30/flhtml/g04/g04eaf.html

Parameters

typstr, length 1

The type of dummy variable to be computed.

If $typ=\text{'P'}$, an orthogonal Polynomial representation is computed.

If $typ=\text{'H'}$, a Helmert matrix representation is computed.

If $typ=\text{'F'}$, the contrasts relative to the First level are computed.

If $typ=\text{'L'}$, the contrasts relative to the Last level are computed.

If $typ=\text{'C'}$, a Complete set of dummy variables is computed.

levelsint

$k$, the number of levels of the factor.

ifactint, array-like, shape $\left(n\right)$

The $n$ values of the factor.

vfloat, array-like, shape $(:)$

Note: the required length for this argument is determined as follows: if $typ=\text{'P'}$: $levels$; otherwise: $1$.

If $typ=\text{'P'}$, the $k$ distinct values of the underlying variable for which the orthogonal polynomial is to be computed.

If $typ\ne \text{'P'}$, $v$ is not referenced.

Returns

xfloat, ndarray, shape $(n,:)$

The $n\times k^{\ast }$ matrix of dummy variables, where $k^{\ast }=k-1$ if $typ=\text{'P'}$, $\text{'H'}$, $\text{'F'}$ or $\text{'L'}$ and $k^{\ast }=k$ if $typ=\text{'C'}$.

repfloat, ndarray, shape $\left(levels\right)$

The number of replications for each level of the factor, $r_{\text{i}}$, for $\text{i}=1,2,\dots ,k$.

Raises

NagValueError

(errno $1$)

On entry, $typ=⟨value⟩$.

Constraint: $typ=\text{'P'}$, $\text{'H'}$, $\text{'F'}$, $\text{'L'}$ or $\text{'C'}$.

(errno $1$)

On entry, $n=⟨value⟩$ and $levels=⟨value⟩$.

Constraint: $n\ge levels$.

(errno $1$)

On entry, $levels=⟨value⟩$.

Constraint: $levels\ge 2$.

(errno $2$)

On entry, not all values of $v$ are distinct.

(errno $2$)

On entry, not all levels are present in $ifact$.

(errno $2$)

On entry, $i=⟨value⟩$, $ifact[i-1]=⟨value⟩$ and $levels=⟨value⟩$.

Constraint: $1\le levels[i-1]\le levels$.

Warns

NagAlgorithmicWarning

(errno $3$)

The $⟨value⟩$$⟨value⟩$ polynomial has all elements zero.

Notes

In the NAG Library the traditional C interface for this routine uses a different algorithmic base. Please contact NAG if you have any questions about compatibility.

In the analysis of an experimental design using a general linear model the factors or classification variables that specify the design have to be coded as dummy variables. dummyvars computes dummy variables that can then be used in the fitting of the general linear model using correg.linregm_fit.

If the factor of length $n$ has $k$ levels then the simplest representation is to define $k$ dummy variables, $X_j$ such that $X_j=1$ if the factor is at level $j$ and $0$ otherwise for $j=1,2,\dots ,k$. However, there is usually a mean included in the model and the sum of the dummy variables will be aliased with the mean. To avoid the extra redundant argument $k-1$ dummy variables can be defined as the contrasts between one level of the factor, the reference level, and the remaining levels. If the reference level is the first level then the dummy variables can be defined as $X_{\text{j}}=1$ if the factor is at level $\text{j}$ and $0$ otherwise, for $\text{j}=2,3,\dots ,k$. Alternatively, the last level can be used as the reference level.

A second way of defining the $k-1$ dummy variables is to use a Helmert matrix in which levels $2,3,\dots ,k$ are compared with the average effect of the previous levels. For example if $k=4$ then the contrasts would be:

$$\begin{array}{c}\begin{array}{ccccc}1& & -1& -1& -1\\ 2& & 1& -1& -1\\ 3& & 0& 2& -1\\ 4& & 0& 0& 3\end{array}\end{array}$$

Thus variable $\text{j}$, for $\text{j}=1,2,\dots ,k-1$ is given by

$X_j=-1$ if factor is at level less than $j+1$

$X_j={\sum }_{i=1}^j{r}_i/r_{j+1}$ if factor is at level $j+1$

$X_j=0$ if factor is at level greater than $j+1$

where $r_j$ is the number of replicates of level $j$.

If the factor can be considered as a set of values from an underlying continuous variable then the factor can be represented by a set of $k-1$ orthogonal polynomials representing the linear, quadratic etc. effects of the underlying variable. The orthogonal polynomial is computed using Forsythe’s algorithm (Forsythe (1957), see also Cooper (1968)). The values of the underlying continuous variable represented by the factor levels have to be supplied to the function.

The orthogonal polynomials are standardized so that the sum of squares for each dummy variable is one. For the other methods integer ($\pm 1$) representations are retained except that in the Helmert representation the code of level $j+1$ in dummy variable $j$ will be a fraction.

References

Cooper, B E, 1968, Algorithm AS 10. The use of orthogonal polynomials, Appl. Statist. (17), 283–287

Forsythe, G E, 1957, Generation and use of orthogonal polynomials for data fitting with a digital computer, J. Soc. Indust. Appl. Math. (5), 74–88