Up Next
Go up to 3 glmlab Reference
Go forward to 3.2 The Main Window Edit Areas

3.1 The Main Window Items

There are eight drop-down menus on the main glmlab screen. For a quick explanation, see Figure 3.1.

A Quick Tour of the Drop-Down Menus
 

3.1.1 The File Menu

3.1.1.1 LOAD Data File

Allows the user to load a data file for use in glmlab, using a graphical interface. A dialog box is issued confirming that the file has loaded correctly. The dialog box initially defaults to the glmlab data directory, but the default directory can be altered by moving the dummydta.m file to the required default folder/directory. See also Section 5.8. 

3.1.1.2 Load glmlab Model

Loads a previously saved glmlab model, restoring details such as the error distribution, link function, scale parameter, residual type and variables entered.

3.1.1.3 Save glmlab Model

Saves a glmlab model, saving details such as the error distribution, link function, scale parameter, residual type and variables entered. A dialog box defaults to saving in the glmlog folder/directory, but this can be changed by moving the file dummylog.m to the desired directory.

3.1.1.4 QUIT glmlab

Quits glmlab and loses all information. The DETAILS.m file will retain its information until glmlab is started again. This option is the same as pressing the QUIT button.

3.1.1.5 EXIT matlab

Exits MATLAB and hence glmlab. The DETAILS.m file will retain its information until glmlab is started again.

3.1.2 The Distributions Menu

Alters the error distribution. The five choices are: normal, gamma, inverse Gaussian, binomial and Poisson. User defined distributions are also possible; see section 5.6. Each distribution has its own set of default link functions and scale parameters as detailed in Table 5.2. User-defined distributions are also possible; see Section 5.6.

The binomial distribution requires two columns in the Response area; one for the observed counts and the other for the sample size. If only one column is given, it is assumed to be probabilities if all its elements are between 0 and 1, otherwise glmlab issues a warning.

3.1.3 The Link Menu

Alters the link function. The choices are: identity, logarithm, reciprocal, square root, power, logit, probit, complementary log-log. The last three are only available when the binomial distribution is selected. User-defined link functions are also possible; see Section 5.6. An edit box is presented for altering the power link function. If the power is given as 0, -1, 0.5, the link function is automatically altered to identity, reciprocal or square root respectively. Each distribution has its own default link function (the distribution's canonical link) as shown in Table 5.2.

3.1.4 The Scale Parameter Menu

The user can chose to use the mean deviance as the scale parameter, or to use a fixed value. When choosing a fixed value, a input dialog box is presented that only allows positive values. Each distribution has its own default scale parameter as shown in Table 5.2.

3.1.5 The Residuals Type Menu

Sets the type of residual that is calculated. The user can choose from Pearson residual (the default), deviance residuals, or quantile residuals (see Dunn and Smyth [4]). Quantile residuals are only available for the distributions that come with glmlab and not for user-defined distributions.

3.1.6 The Options Menu

There are several options that can be chosen as detailed below.

3.1.6.1 Declare New Model

After fitting models, this option should be selected to restore all options and reset glmlab. After selecting this option, the DETAILS.m file will be overwritten. This is the same as pressing the NEW MODEL button.

3.1.6.2 Restore Default Settings

This option restores all the default settings. It can be selected if the user has become lost in setting the options elsewhere.

3.1.6.3 Warning Message Status

MATLAB often issues warnings. These warnings can be disabled or enabled in this menu. For more details, type help warning.

3.1.6.4 Change Fitting Parameters

There are three parameters that the user can change:

The parameter values are stored in the PARVALS.mat file in the same directory as the DETAILS.m file (usually the glmlog directory).

3.1.6.5 Include Constant Term

This options toggles the inclusion of the constant term in the fitting of the model. By default, the constant term is included in the fitting.

3.1.6.6 Output Display Information

The glmlab output usually contains the parameter estimates and their standard errors; and the deviance, degrees of freedom and changes in them both. The user can decide not to display the parameter estimates and standard errors by disabling Display Parameter Values. The user can also display more information--such as the number of iterations to convergence--by selecting the Display Fitting Information. 

3.1.6.7 Recycle Fitted Values

At the start of each fit, glmlab usually uses an initial estimate such that µ=y. In some cases, adjustments are made in case the response is zero. However, by selecting this option, glmlab will use the previous fitted values for the initial estimate in the iterations.

3.1.7 The Plots Menu

Produces residual plots from the current fit. This menu item is unavailable until a model has been fitted, after changes have been made to the model structure (altering the distribution, link function, or scale parameter), and after changing the type of residual that is to be calculated.

These plots are plotted when the appropriate button is pressed. The type of residual used depends on the type of residual chosen in the Residuals Type menu, and some plots are unavailable for certain distributions and residuals types. glmlab labels the plots as best as it is able. Apart from the plots listed below, glmlab also has available the facility to plot histograms using MATLAB's hist command. The six options are:

3.1.8 The Help Menu

The help menu is far from thorough, but should be sufficient when used in conjunction with this manual.

3.1.8.1 On-line Manual

Since you're reading the on-line manual, you should know about this option!

3.1.8.2 Help with Main Window Items

This presents a screen of basic help concerning the items in the main area of the main glmlab window.

3.1.8.3 Help with Menu Items

This presents a screen of basic help concerning the drop-down menu items.

3.1.8.4 Help with Interactions

glmlab uses the @ symbol to specify that two (or more) variables interact. This help screen gives brief instructions on how to specify interactions.

3.1.8.5 Help with OUTPUT VARIABLES

A brief explanation is provided of all variables returned into the workspace by glmlab. The variables returned are explained in Section 3.5.

3.1.8.6 Help with Residuals Items

This presents a screen of basic help for the Residuals window.

3.1.8.7 Run glmlab Demo

This begins a small introductory demonstration of glmlab. While the demonstration is running, the user is unable to fit models.

3.1.8.8 Where to get glmlab

Places where glmlab can be found are listed here.

3.1.8.9 Contact the Author

This option allows the user to email the author of glmlab. The author encourages you to email him if you are using the program to let him know what you think, or to give suggestions for improvements, or how you are using glmlab.

3.1.8.10 Initial Splash Screen

This option redisplays the splash screen that is displayed when glmlab is first started.

3.1.8.11 Last Revision

This is only for information. The date of the latest change--even if a minor one--is given here.


Peter Dunn

Up Next