Learn R Programming

⚠️There's a newer version (1.5.8) of this package.Take me there.

momentuHMM

R package for Maximum likelihood analysis Of animal MovemENT behavior Using multivariate Hidden Markov Models

Get started with the vignette: Guide to using momentuHMM

Installation instructions

CRAN release

The package is available at . To install it:

install.packages("momentuHMM")

Install from Github

To install the latest (stable) version of the package from Github:

library(devtools)
install_github("bmcclintock/momentuHMM")

To install the latest (unstable) version of the package from Github:

library(devtools)
install_github("bmcclintock/momentuHMM", ref="develop")

References

McClintock, B.T., Michelot, T. (2018) momentuHMM: R package for generalized hidden Markov models of animal movement. Methods in Ecology and Evolution, 9(6), 1518-1530.

McClintock, B.T., King R., Thomas L., Matthiopoulos J., McConnell B.J., Morales J.M. (2012) A general discrete-time modeling framework for animal movement using multistate random walks. Ecological Monographs, 82(3), 335-349.

McClintock, B.T. (2017) Incorporating telemetry error into hidden Markov models of animal movement using multiple imputation. Journal of Agricultural, Biological, and Environmental Statistics, 22(3), 249-269.

Copy Link

Version

Install

install.packages('momentuHMM')

Monthly Downloads

625

Version

1.4.3

License

GPL-3

Maintainer

Brett T McClintock

Last Published

November 22nd, 2018

Functions in momentuHMM (1.4.3)

checkPar0

dbeta_rcpp

Probability density function of the beta distribution (written in C++)
crawlWrap

Fit and predict tracks for using crawl
crwData

Constructor of crwData objects
crawlMerge

Merge crwData object with additional data streams and/or covariates
dexp_rcpp

Exponential density function
circAngles

Convert standard direction angles (in radians relative to the x-axis) to turning angle covariates suitable for circular-circular regression on the angle mean
exGen

Example data simulation
MIfitHMM

Fit HMMs to multiple imputation data
example

Example dataset
AICweights

Calculate Akaike information criterion model weights
AIC.momentuHMM

AIC
crwSim

Constructor of crwSim objects
is.miHMM

Is miHMM
XBloop_rcpp

Get XB
MIpool

Calculate pooled parameter estimates and states across multiple imputations
is.miSum

Is miSum
logAlpha

Forward log-probabilities
dbern_rcpp

Bernoulli density function
expandPar

Expand vector of free working parameters to vector of all working parameters including any fixed parameters (used in fitHMM.R and nLogLike.R)
plot.momentuHMMData

Plot momentuHMMData
logBeta

Backward log-probabilities
fitHMM

Fit a multivariate HMM to the data
dgamma_rcpp

Gamma density function
dweibull_rcpp

Weibull density function
dpois_rcpp

Poisson density function
dvm_rcpp

Von Mises density function
getPar

Get starting values from momentuHMM, miHMM, or miSum object returned by fitHMM, MIfitHMM, or MIpool
plotPR

Plot pseudo-residuals
is.crwData

Is crwData
is.crwSim

Is crwSim
getPar0

Get starting values for new model from existing momentuHMM model fit
momentuHMM

Constructor of momentuHMM objects
dwrpcauchy_rcpp

Wrapped Cauchy density function
miHMM

Constructor of miHMM objects
momentuHMMData

Constructor of momentuHMMData objects
nLogLike_rcpp

Negative log-likelihood
miSum

Constructor of miSum objects
getCovNames

Get names of any covariates used in probability distribution parameters
plotSat

Plot observations on satellite image
dlnorm_rcpp

Log-normal density function
distAngle

Calculate distance between points y and z and turning angle between points x, y, and z
plotSpatialCov

Plot observations on raster image
getDM_rcpp

Get design matrix
parDef

Parameters definition
plotStates

Plot states
dnorm_rcpp

Normal density function
simData

Simulation tool
setStateNames

Set stateNames for a momentuHMM, miHMM, HMMfits, or miSum object
timeInStates

Calculate proportion of time steps assigned to each state (i.e. “activity budgets”)
trMatrix_rcpp

Transition probability matrix
plotStationary

Plot stationary state probabilities
is.momentuHMM

Is momentuHMM
getParDM

Get starting values on working scale based on design matrix and other parameter constraints
is.momentuHMMData

Is momentuHMMData
stationary

Stationary state probabilities
prepData

Preprocessing of the data streams and covariates
is.HMMfits

Is HMMfits
nLogLike

Negative log-likelihood function
n2w

Scaling function: natural to working parameters.
plot.miSum

Plot miSum
summary.momentuHMMData

Summary momentuHMMData
plot.crwData

Plot crwData
print.miHMM

Print miHMM
w2n

Scaling function: working to natural parameters
plot.momentuHMM

Plot momentuHMM
plot.miHMM

Plot miHMM
print.momentuHMM

Print momentuHMM
print.miSum

Print miSum
simObsData

Observation error simulation tool
pseudoRes

Pseudo-residuals
setModelName

Set modelName for a momentuHMM, miHMM, HMMfits, or miSum object
stateProbs

State probabilities
turnAngle

Turning angle
viterbi

Viterbi algorithm
HMMfits

Constructor of HMMfits objects
allProbs

Matrix of all probabilities
CIbeta

Confidence intervals for working (i.e., beta) parameters
CIreal

Confidence intervals for the natural (i.e., real) parameters