R/struc__tab2df.R

In wanyuac/handyR: Handy functions for R programming.

#' @title Table to data frame
#' @description Converts a table from function "table" to a two column data frame.
#' @param t Input table
#' @param new_names A character vector of two elements for new column names. Default: Name, Count.
#' @param srt Sort the output data frame by its second column. Legit values: NA, "decreasing", and "increasing".
#' @export
# (C) Copyright 2020 Yu Wan <wanyuac@126.com>
# Licensed under the Apache License, Version 2.0
# Publication: 24 July 2020; latest update: 24 August 2022

tab2df <- function(t, new_names = NA, srt = NA) {
    df <- data.frame(Name = names(t), Count = as.integer(t), stringsAsFactors = FALSE)
    if (!is.na(new_names)[1]) {
        if (length(new_names) >= 2) {
            names(df) <- as.character(new_names)
        }
    }
    if (!is.na(srt)) {
        if (srt == "decreasing") {
            df <- df[order(df[, 2], decreasing = TRUE), ]
        } else {
            df <- df[order(df[, 2], decreasing = FALSE), ]
        }
    }

    return(df)
}