Learn more about SimBiology

sbiofitstatusplot - Plot status of sbionlmefit

Syntax

stop = sbiofitstatusplot(beta, status, state)

Description

stop = sbiofitstatusplot(beta, status, state) initializes or updates a plot with the fixed effects, beta, the log likelihood status.fval, and the variance of the random effects, diag(status.Psi).

The function returns an output (stop) to satisfy requirements for the 'OutputFcn' option of nlmefit. For sbiofitstatusplot, the value of stop is always false.

Specify sbiofitstatusplot in the sbionlmefit function using the optionstruc (options structure) argument, to obtain status information about NLME fitting. Use sbiofitstatusplot or customize your own function to use in the options structure.

Inputs

beta

The current fixed effects.

status

Structure containing several fields.

Field Value

inner
Structure describing the current status of the inner iterations within the ALT and LAP procedures, with the fields:
procedure
'PNLS', 'LME', or 'none' when the procedure is 'ALT'
'PNLS', 'PLM', or 'none' when the procedure is 'LAP'
state — 'init', 'iter', 'done', or 'none'
iteration — Integer starting from 0, or NaN

procedure 'ALT' or 'LAP'

iteration Integer starting from 0

fval Current log-likelihood

Psi Current random-effects covariance matrix

theta Current parameterization of Psi

mse Current error variance

state

Either 'init', 'iter', or 'done'.

Definitions

Alt

Alternating algorithm for the optimization of the LME or RELME approximations

FO

First-order estimate

FOCE

First-order conditional estimate

LAP

Optimization of the Laplacian approximation for FO or FOCE

LME

Linear mixed-effects estimation

NLME

Nonlinear mixed effects

PLM

Profiled likelihood maximization

PNLS

Penalized nonlinear least squares

RELME

Restricted likelihood for the linear mixed-effects model

Examples

Obtain status information for NLME fitting:

% Create options structure with 'OutputFcn'.
options.Options.OutputFcn = @sbiofitstatusplot;
% Pass options structure with OutputFcn to sbionlmefit function.
results = sbionlmefit(..., options);