R/matrix_to_tibble.R

In quantable: Streamline Descriptive Analysis of Quantitative Data Matrices

#' Matrix to tibble (taken from tidyquant)
#' 
#' @param x a matrix
#' @param preserve_row_names should rownames be kept (default TRUE)
#' @param ... further parameters passed to as_tibble
#' @importFrom dplyr bind_cols
#' @importFrom tibble tibble as_tibble
#' @export
#' 
matrix_to_tibble <- function(x, preserve_row_names = TRUE,...)
{
  if (!is.matrix(x)) stop("Error: `x` is not a matrix object.")
  if (preserve_row_names == TRUE) {
    row.names <- rownames(x)
    if (!is.null(row.names)  ) {
      #&& !identical(row.names, 1:nrow(x) %>% as.character())
      dplyr::bind_cols(
        tibble::tibble(row.names),
        tibble::as_tibble(x, ...)
      )
      
    } else {
      
      warning(paste0("Warning: No row names to preserve. ",
                     "Object otherwise converted to tibble successfully."))
      tibble::as_tibble(x, ...)
    }
    
  } else {
    
    tibble::as_tibble(x, ...)
    
  }
}