R/do.list.summary.R

In sydneycytometry/Spectre: A computational toolkit in R for the integration, exploration, and analysis of high-dimensional single-cell cytometry data.

#' Summarise the column names and row numbers for elements of a list
#'
#' @usage do.list.summary(dat)
#'
#' @param dat NO DEFAULT. A list of data.tables that you wish to create some summary information for
#'
#' @return Returns a new list summarising the data.tables in your list.
#'
#' @author Thomas M Ashhurst, \email{thomas.ashhurst@@sydney.edu.au}
#'
#' @references \url{https://sydneycytometry.org.au/spectre}.
#'
#' @import data.table
#'
#' @export

do.list.summary <- function(dat)

{

  ### Setup lists
      res.list <- list()

      ncol.check <- list()
      colName.check <- list()
      nrow.check <- list()

  ### Create summary data
      for(i in c(1:(length(dat)))){ncol.check[[i]] <- length(names(dat[[i]]))} # creates a list of the number of columns in each sample
      for(i in c(1:(length(dat)))){colName.check[[i]] <- names(dat[[i]])}
      name.table <- data.frame(matrix(unlist(colName.check), nrow = length(dat), byrow = T))
      for(i in c(1:(length(dat)))){nrow.check[[i]] <- nrow(dat[[i]])}

      ncol.check <- as.matrix(ncol.check)
      nrow.check <- as.matrix(nrow.check)

  ### Structure results list

      res.list$name.table <- name.table
      res.list$ncol.check <- ncol.check
      res.list$nrow.check <- nrow.check

  ### Return
      return(res.list)
}