Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented sorting in all functions except for two-way tables. #29

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Implemented sorting in all functions except for two-way tables. #29

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c898af
Implemented sorting in all functions except for `tab2`, where a warni…
theshiniss May 25, 2024
5a1e0ef
Modified NEWS.md and added tests
theshiniss May 27, 2024
ffc85d8
Typo on tab.R
theshiniss May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 25 additions & 15 deletions R/tab.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,20 @@
#' The convenience functions `tab1()` and `tab2()` are inspired by functions of the same name in Stata. They allow rapid tabulation of a set of variables. `tab1()` creates one-way tables of frequencies for each listed variable. `tab2()` creates two-way tables of frequencies for all listed variable combinations.
#'
#' @usage
#' tab(x, ..., m = TRUE)
#' tab(x, ..., m = TRUE, sort = FALSE)
#'
#' ta(x, ..., m = TRUE)
#' ta(x, ..., m = TRUE, sort = FALSE)
#'
#' ftab(x, ..., m = TRUE)
#' ftab(x, ..., m = TRUE, sort = FALSE)
#'
#' tab1(x, ..., m = TRUE)
#' tab1(x, ..., m = TRUE, sort = FALSE)
#'
#' tab2(x, ..., m = TRUE)
#'
#' @param x A vector, data.frame, or tibble.
#' @param ... A comma separated list of unquoted variable names or positions. Select helpers from [dplyr](https://dplyr.tidyverse.org/reference/select.html) and [tidyselect](https://rdrr.io/cran/tidyselect/man/select_helpers.html) are supported.
#' @param m If `TRUE` (the default), missing values are reported.
#' @param sort If `TRUE` (default is `FALSE`), will show the largest groups at the top. Sorting is not implemented for two-way tables.
Copy link
Owner

@gvelasq gvelasq May 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be worth mentioning here that the default behavior is to sort (ascending) by value and that sort = TRUE changes this behavior to sort (descending) by frequency.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

#'
#' @details
#' If a single variable is passed to `tab()`, a table of frequencies is printed (with a total row and columns 'Freq.', 'Percent', and 'Cum.').
Expand Down Expand Up @@ -85,34 +86,37 @@

#' @rdname tab
#' @export
tab <- function(x, ..., m = TRUE) {
tab <- function(x, ..., m = TRUE, sort = FALSE) {
vars <- rlang::quos(...)
if (!exists("x_name", envir = x_env)) {
set_x_name(rlang::quo_name(rlang::enexpr(x)))
}
if (length(vars) == 0L) {
df_to_return <- ftab(x, ..., m = m)
df_to_return <- ftab(x, ..., m = m, sort = sort)
} else {
vars <- lapply(vars, rlang::env_bury, !!!helpers)
varnames <- tidyselect::vars_select(names(x), !!!vars)
if (length(varnames) == 1L | length(varnames) > 2L) {
df_to_return <- ftab(x, !!!vars, m = m)
df_to_return <- ftab(x, !!!vars, m = m, sort = sort)
}
if (length(varnames) == 2L) {
if (sort) {
warning("Sorting is not implemented for two-way tables.")
}
df_to_return <- ctab(x, !!!vars, m = m)
}
}
invisible(df_to_return)
}

#' @export
ta <- function(x, ..., m = TRUE) {
ta <- function(x, ..., m = TRUE, sort = FALSE) {
set_x_name(rlang::quo_name(rlang::enexpr(x)))
tab(x, ..., m = m)
tab(x, ..., m = m, sort = sort)
}

#' @export
ftab <- function(x, ..., m = TRUE) {
ftab <- function(x, ..., m = TRUE, sort = FALSE) {
if (!exists("x_name", envir = x_env)) {
set_x_name(rlang::quo_name(rlang::enexpr(x)))
}
Expand All @@ -125,7 +129,7 @@ ftab <- function(x, ..., m = TRUE) {
if (length(vars) == 0L) {
if (rlang::is_atomic(x) == TRUE) {
x <- tibble::enframe(x, name = NULL)
x <- dplyr::count(x, .data[["value"]])
x <- dplyr::count(x, .data[["value"]], sort = sort)
x <- dplyr::rename(x, !!x_name := .data[["value"]], Freq. = .data[["n"]])
}
} else {
Expand All @@ -135,6 +139,9 @@ ftab <- function(x, ..., m = TRUE) {
x <- dplyr::group_by_at(x, names(varnames))
x <- dplyr::summarize(x, Freq. = dplyr::n())
x <- dplyr::ungroup(x)
if (sort) {
x <- dplyr::arrange(x,desc(Freq.))
}
}
x <- dplyr::mutate(x, Percent = formatC(.data[["Freq."]] / sum(.data[["Freq."]]) * 100, digits = 1L, format = "f"), Cum. = formatC(cumsum(.data[["Percent"]]), digits = 1L, format = "f"))
df_to_return <- x
Expand All @@ -153,19 +160,19 @@ ftab <- function(x, ..., m = TRUE) {
}

#' @export
tab1 <- function(x, ..., m = TRUE) {
tab1 <- function(x, ..., m = TRUE, sort = FALSE) {
vars <- rlang::quos(...)
if (!exists("x_name", envir = x_env)) {
set_x_name(rlang::quo_name(rlang::enexpr(x)))
}
if (length(vars) == 0L) {
ftab(x, ..., m = m)
ftab(x, ..., m = m, sort = sort)
} else {
vars <- lapply(vars, rlang::env_bury, !!!helpers)
varnames <- tidyselect::vars_select(names(x), !!!vars)
for (i in seq_along(varnames)) {
tmp <- dplyr::select(x, !!!varnames[[i]])
tab(tmp, !!varnames[[i]], m = m)
tab(tmp, !!varnames[[i]], m = m, sort = sort)
if (i < length(varnames)) {
cat("\n")
}
Expand All @@ -174,7 +181,10 @@ tab1 <- function(x, ..., m = TRUE) {
}

#' @export
tab2 <- function(x, ..., m = TRUE) {
tab2 <- function(x, ..., m = TRUE, sort = FALSE) {
if (sort) {
warning("Sorting is not implemented for two-way tables.")
}
vars <- rlang::quos(...)
vars <- lapply(vars, rlang::env_bury, !!!helpers)
varnames <- tidyselect::vars_select(names(x), !!!vars)
Expand Down