write.modeldef {Rglimclim}R Documentation

Write a model definition file

Description

To write a definition file for an object of class GLC.modeldef, that can be read subsequently using read.modeldef.

Usage

write.modeldef(x, file, check.file=TRUE, mean.only=FALSE)

Arguments

x

An object of class GLC.modeldef, for example resulting from a call to GLCfit.

file

Name(s) of output file(s). If x is a joint mean-variance model then this should be a vector of length two (one file for the mean component and one for the dispersion); otherwise a single character string.

check.file

If TRUE (the default), the routine checks that the output file(s) in file does / do not already exist; if it does / they do, user will be prompted before proceeding.

mean.only

If TRUE, the routine will only write information relating to the mean component of the model (no dispersion info, spatial structure etc.). Defaults to FALSE.

Details

This function is provided for back-compatibility with GLIMCLIM (rather than Rglimclim). See the documentation for read.modeldef for more details.

Value

The function returns a NULL value: its effect is solely to write a model specification to file.

Author(s)

Richard Chandler (richard@stats.ucl.ac.uk)

See Also

read.modeldef, and GLCfit for examples.


[Package Rglimclim version 1.3-2 Index]