R/stackByColumn.R

In bryanhanson/HandyStuff: Handy Functions & Stuff

##' Convert a Vector into a Matrix Filling Down Columns
##'
##' This is one of several related convenience functions designed to convert
##' vectors into matrices or matrices into vectors, either by row or by column.
##' 
##' @param IN An integer or numeric vector.
##'
##' @param nrow The number of rows in the final matrix.
##'
##' @param ncol The number of columns in the final matrix.
##'
##' @return A ncol x nrow matrix with no attributes
##' 
##' @name stackByColumn
##' @rdname stackByColumn
##' @export
##' @keywords utilities
##'
##' @seealso \code{\link{stackByRow}}, \code{\link{vectorizeByColumn}},
##' \code{\link{vectorizeByRow}}
##'
##' @details  This function is almost the same as
##' \code{\link{matrix}}, with \code{byrow = FALSE}, and
##' there are no dimnames or attributes in this function.
##' 
##' @examples
##' stackByColumn(IN = 1:20, nrow = 5, ncol = 4)

stackByColumn <- function(IN, nrow, ncol){
	if (length(IN)/nrow != ncol) stop("Dimensions don't make sense in stackByColumn")
	OUT <- matrix(NA_real_, nrow = nrow, ncol = ncol)
	idx <- seq(nrow, length(IN), nrow)
	for (n in 1:ncol){
		OUT[,n] <- IN[(idx[n]-nrow+1):(idx[n])]
		}
	OUT
	}