displayPar: Display the order of parameters along with fixed values and...

In NMML/crawl: Fit Continuous-Time Correlated Random Walk Models to Animal Movement Data

Display the order of parameters along with fixed values and starting values

Description

This function takes the model specification arguments to the crwMLE function and displays a table with the parameter names in the order that crwMLE will use during model fitting. This is useful for specifying values for the fixPar or theta (starting values for free parameters) arguments.

Usage

displayPar(
  mov.model = ~1,
  err.model = NULL,
  activity = NULL,
  drift = FALSE,
  data,
  Time.name,
  theta,
  fixPar,
  ...
)

Arguments

mov.model	formula object specifying the time indexed covariates for movement parameters.
err.model	A 2-element list of formula objects specifying the time indexed covariates for location error parameters.
activity	formula object giving the covariate for the stopping portion of the model.
drift	logical indicating whether or not to include a random drift component.
data	data.frame object containing telemetry and covariate data. A SpatialPointsDataFrame object from the package 'sp' will also be accepted.
Time.name	character indicating name of the location time column
theta	starting values for parameter optimization.
fixPar	Values of parameters which are held fixed to the given value.
...	Additional arguments (probably for testing new features.)

Value

A data frame with the following columns

ParNames	The names of the parameters specified by the arguments.
fixPar	The values specified by the fixPar argument for fixed values of the parameters. In model fitting, these values will remain fixed and will not be estimated.
thetaIndex	This column provides the index of each element of the theta argument and to which parameter it corresponds.
thetaStart	If a value is given for the theta argument it will be placed in this column and its elements will correspond to the thetaIdx column.

Author(s)

Devin S. Johnson

See Also

demo(northernFurSealDemo) for example.

NMML/crawl documentation built on Oct. 9, 2024, 11:56 a.m.