man-roxygen/weights-return.R

In mronkko/matrixpls: Matrix-Based Partial Least Squares Estimation

#'@return An object of class \code{"matrixplsweights"}, which is a matrix containing the weights with the following attributes: 
#'@return \item{iterations}{Number of iterations performed}
#'@return \item{converged}{A boolean indicating if the algorithm converged}
#'@return \item{history}{A data.frame containing the weights for each iteration}
#'
#'@family Weight algorithms