man-roxygen/as.big.matrix_methods_template.R

In kaneplusplus/bigmemory: Manage Massive Matrices with Shared Memory and Memory-Mapped Files

#' @name as.big.matrix-methods
#' @docType methods
#' @aliases as.big.matrix-methods 
#' as.big.matrix,matrix-method
#' as.big.matrix,vector-method
#' as.big.matrix,data.frame-method
#' @title Create a ``big.matrix'' from a matrix or vector.
#' @description
#' Create a \code{\link{big.matrix}} from a \code{matrix} or \code{vector}
#' or \code{\link{data.frame}};
#' a \code{vector} will result in a \code{\link{big.matrix}} with one column.
#' A data frame will have character vectors converted to factors, and then
#' all factors converted to numeric factor levels.  All labels or character
#' values will be lost.
#' @section Methods:
#' \describe{
#'  \item{\code{signature(x = "matrix")}}{ ... }
#'  \item{\code{signature(x = "vector")}}{ ... }
#'  \item{\code{signature(x = "data.frame")}}{ ... }
#' }
#' @keywords methods