man-roxygen/Example-a4aM.R

In flr/FLa4a: A Simple and Robust Statistical Catch at Age Model

#' @examples
#' age <- 0:15
#' k <- 0.4
#' shp <- eval(as.list(~exp(-age-0.5))[[2]], envir=list(age=age))
#' lvl <- eval(as.list(~1.5*k)[[2]], envir=list(k=k))
#' M <- shp*lvl/mean(shp)
#' # Now set up an equivalent a4aM object
#' mod1 <- FLModelSim(model=~exp(-age-0.5))
#' mod2 <- FLModelSim(model=~1.5*k, params=FLPar(k=0.4))
#' m1 <- a4aM(shape=mod1, level=mod2)
#'   # set up the age range for the object...
#'   rngquant(m1) <- c(0,15)
#'   # ...and the age range for mbar
#'   rngmbar(m1)<-c(0,15)
#' m(m1)
#' mean(m(m1)[ac(0:15)])
#' all.equal(M, c(m(m1)))
#'
#' # another example m
#' rngquant(m1) <- c(2,10)
#' rngmbar(m1) <- c(2,4)
#' m(m1)
#' mean(m(m1)[ac(2:4)])
#'
#' # example with specified iters...
#' mod2 <- FLModelSim(model=~k^0.66*t^0.57, params=FLPar(matrix(c(0.4,10,0.5,11), ncol=2, dimnames=list(params=c("k","t"), iter=1:2))), vcov=array(c(0.004,0.00,0.00,0.001), dim=c(2,2,2)))
#' m2 <- a4aM(shape=mod1, level=mod2)
#' rngquant(m2) <- c(0,10)
#' m(m2)
#' # ...and with randomly generated iters
#' m3 <- a4aM(shape=mod1, level=mvrnorm(100, mod2))
#' rngquant(m3) <- c(0,15)
#' m(m3)
#'
#' # example with a trend
#' mod3 <- FLModelSim(model=~1+b*v, params=FLPar(b=0.05))
#' mObj <- a4aM(shape=mod1, level=mvrnorm(100, mod2), trend=mod3, range=c(min=0,max=15,minyear=2000,maxyear=2003,minmbar=0,maxmbar=0))
#' m(mObj, v=1:4)