R/mc_id.R

Defines functions mc_id

Documented in mc_id

#' @title Independent Model Structure
#' @author Wagner Hugo Bonat, \email{wbonat@@ufpr.br}
#'
#' @description Builds an identity matrix to be used as a component of
#' the matrix linear predictor. It is in general the first component of
#' the matrix linear predictor, a kind of intercept matrix.
#'
#' @param data the data set to be used.
#' @return A list of matrix.
#' @seealso \code{mc_dist}, \code{mc_ma}, \code{mc_rw} and \code{mc_mixed}.
#'
#' @source Bonat, W. H. (2018). Multiple Response Variables Regression
#' Models in R: The mcglm Package. Journal of Statistical Software, 84(4):1--30.
#'
#' @export

mc_id <- function(data) {
  output <- list("Z0" = Diagonal(dim(data)[1],1))
  return(output)
}
wbonat/mcglm documentation built on June 23, 2020, 11:06 a.m.