R/first_five.R

In abaghela/functionjunction: Misc Functions

#' @title functionjunction
#'
#' @description Return the first X rows and columns
#'
#' @param matrix
#'
#' @return dataframe
#'
#' @examples
#' functionjunction::first_five(mat)
#'
#' @export

first_five <- function(mat, rows = 5, columns = 5) {

  # Confirm this is a matrix or dataframe
  if (!(is.matrix(mat) | is.data.frame(mat))) {
    return(cat("This ain't a matrix or dataframe.") )
  }

  mat <- as.data.frame(mat)

  mat_rows = nrow(mat)
  mat_cols = ncol(mat)

  # Are there fewer rows/columnns than requested?
  if (mat_rows < rows){
    rows = mat_rows
  }
  if (mat_cols < columns){
    columns = mat_cols
  }

  mat <- mat[1:rows,1:columns]
  return(mat)
}