R/merge.mark.r

In RMark: R Code for Mark Analysis

#' Merge mark model objects and lists of mark model objects
#' 
#' Merge an unspecified number of marklist and mark model objects into a single
#' marklist with an optional table of model results if \code{table=TRUE}.
#' 
#' 
#' @usage \method{merge}{mark}(...,table=TRUE)
#' @param ...  an unspecified number of marklist and/or mark model objects
#' @param table if TRUE, a table of model results is also included in the returned list
#' @return model.list: a list of \code{mark} models and optionally a table of
#' model results.
#' @author Jeff Laake
#' @export merge.mark
#' @export
#' @seealso
#' \code{\link{collect.models}},\code{\link{remove.mark}},\code{\link{run.models}},\code{\link{model.table}},\code{\link{dipper}}
#' @keywords utility
#' @examples
#' 
#' # see example in dipper
#' 
merge.mark=function(...,table=TRUE)
{
#
# Merges an unspecified number of marklist or mark model objects
# together into a marklist object with a model.table if model.table is TRUE.
#
#  Get arguments specified in ... and get their names
#
  args=list(...)
  names(args) = sapply(match.call(expand.dots = FALSE)$..., as.character)

#
# Create an empty list and loop over each value in the arguments
#
  newlist=list()
  for(i in 1:length(args))
  {
#
#    If the object is a single mark object add it to the list
#
     if(inherits(args[[i]],"mark"))
     {
        newnames=c(names(newlist),names(args)[i])
        newlist=c(newlist,args[i])
        names(newlist)=newnames
     }
#
#    If it is a marklist, add each of the models in the list
#
     else
        if(inherits(args[[i]],"marklist"))
        {
           if(!is.null(args[[i]]$model.table))
              args[[i]]$model.table=NULL
           newlist=c(newlist,args[[i]])
        }
#
#       If the argument is neither a mark object or marklist object then give
#       an error message and skip over it.
#
        else
           message(paste("Objects must be of class mark or marklist.",names(args)[i],"ignored"))
  }
#
# Add a model table for the mark models if requested; assign class of marklist and
# return the result
#
  if(table) newlist=c(newlist,model.table=list(model.table(newlist)))
  class(newlist)="marklist"
  return(newlist)
}