R/fun_freqsum_table.r

In theMisdemeanorJusticeProject/mjp: MJP R Package

#' Frequency summary report, a MJP team defined function
#' 
#' @param dataset     a dataset to run the summary
#' @param path_report_output a path to store the summary output, have to be specified as a .csv file.
#' @param x     number of categories shown in the summary table, default = 20.
#' @param sort_by      sort summary table by "VARIABLE" = category lable or "COUNT" = freqency
#' @param sort_descending     show the result in acsending or descending order, default = TRUE, in descending order.
#' 
#' @return  A .csv file has the frequency summary table for each of the variable.
#' 
#' @examples
#'     fun_freqsum_table(my_df , "C:\\Users\\tlin\\Dropbox\\Richie\\RFiles\\summary.csv")
#'     fun_freqsum_table(my_df , "C:\\Users\\tlin\\Dropbox\\Richie\\RFiles\\summary.csv", x = 50,  sort_by = "VARIABLE", sort_descending = T)
#' @export
fun_freqsum_table <- function(dataset, 
                              path_report_output,
                              x = 20,
                              sort_by = "COUNT",
                              sort_descending = T) {
    # Empty the csv file.
    tmp_csv <- file(path_report_output, open = "w")
    truncate(tmp_csv)
    
    # make sure the datset is a data.frame
    dataset <- data.frame(dataset)
    
    for (i in 1:ncol(dataset)) {
        write.table(
            data.frame(i ,
                       names(dataset)[i],
                       class(dataset[, i])[1]),
            path_report_output,
            sep = ",",
            row.names = F,
            col.names = F,
            append = T
        )
        
        if (is.factor(dataset[, i])) {
            tmp_sum <- freqsum(dataset[, i], x = x, sort_by = sort_by , sort_descending = sort_descending)
        } else if (any(is.integer(dataset[, i]),
                       is.numeric(dataset[, i]))) {
            tmp_sum <-
                as.data.frame(unclass(summary(dataset[, i])))
            tmp_sum[, 2] <- tmp_sum[, 1]
            tmp_sum[, 1] <- rownames(tmp_sum)
            names(tmp_sum) <-
                c("Descriptive" , names(dataset)[i])
        } else if (is.POSIXct(dataset[, i])) {
            tmp_sum <-
                as.data.frame(unclass(summary(dataset[, i])))
            tmp_sum[, 2] <-
                as.POSIXct(tmp_sum[, 1], origin = ymd("1970-01-01"))
            tmp_sum[, 1] <- rownames(tmp_sum)
            names(tmp_sum) <-
                c("Descriptive" , names(dataset)[i])
        } else if (any(is.logical(dataset[, i]),
                       is.character(dataset[, i]))) {
            tmp_sum <- freqsum(as.factor(dataset[, i]))
        }
        
        write.table(
            tmp_sum,
            path_report_output,
            sep = ",",
            row.names = F,
            col.names = T,
            append = T
        )
        write.table(
            matrix("", 2, 4),
            path_report_output,
            sep = ",",
            row.names = F ,
            col.names = F,
            append = T
        )
    }
    
}