R/exampleData.R

In bmcclintock/momentuHMM: Maximum Likelihood Analysis of Animal Movement Behavior Using Multivariate Hidden Markov Models

# Roxygen documentation for the example data

#' Example dataset
#'
#' These data are used in the examples and tests of
#' functions to keep them as short as possible.
#'
#' \code{example} is a list of the following objects for demonstrating \code{\link{fitHMM}}:
#' \itemize{
#' \item \code{m} A \code{\link{momentuHMM}} object
#' \item \code{simPar} The parameters used to simulate \code{data}
#' \item \code{par0} The initial parameters in the optimization to fit \code{m}
#' }
#' 
#' \code{miExample} is a list of the following objects for demonstrating \code{\link{crawlWrap}}, \code{\link{MIfitHMM}}, and \code{\link{MIpool}}:
#' \itemize{
#' \item \code{obsData} Simulated observation data with measurement error and temporal irregularity (generated by \code{\link{simData}})
#' \item \code{bPar} initial parameter estimates for \code{MIfitHMM} examples
#' }
#' 
#' \code{forest} is a simulated spatial covariate \code{\link[raster]{raster}} object of the \code{RasterLayer} class
#'
#' @aliases example miExample forest
#' @name exampleData
#' @usage example 
#' @usage miExample 
#' @usage forest
#' @docType data
NULL