Skip to content

Commit

Permalink
Lots of changes v0.2.1
Browse files Browse the repository at this point in the history 
Changed version from 0.2 to 0.2.1
Made freq_table easier to row bind.
Changed mean_table to follow the same variable name conventions.
Updated all vignettes and tests
Created unit tests for format_table
  • Loading branch information
@mbcann01
mbcann01 committed Jan 8, 2018
1 parent fc8a044 commit a27ed38
Show file tree
Hide file tree
Showing 22 changed files with 1,202 additions and 624 deletions.
Binary file added .DS_Store
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: bfuncs
Type: Package
Title: This Repository Is A Random Smattering Of Functions I Wrote For Myself - You Can Use Them Too
Version: 0.2
Version: 0.2.1
Author: person("Brad", "Cannell", email = "brad.cannell@gmail.com", role = c("aut", "cre"))
Maintainer: Brad Cannell <brad.cannell@gmail.com>
Description: Random functions for me.
Expand Down
Binary file added R/.DS_Store
View file
Binary file not shown.
110 changes: 84 additions & 26 deletions R/format_table.R
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#'
#' @param ... Other parameters to be passed on.
#'
#' @param digits Determines the number of decimal place to display. Passed to
#' @param digits Determines the number of decimal places to display. Passed to
#' the "nsmall =" parameter of the format function.
#'
#' Note: Changing the digits argument to format_table will change the number
Expand Down Expand Up @@ -40,30 +40,76 @@
#'
#' data(mtcars)
#'
#' # Overall mean table
#' # Overall mean table with defaults
#'
#' mtcars %>%
#' mean_table(mpg) %>%
#' format_table()
#'
#' #> # A tibble: 1 x 2
#' #> var mean_95
#' #> <chr> <chr>
#' #> 1 mpg 20.09 (17.92 - 22.26)
#' #> response_var mean_95
#' #> <chr> <chr>
#' #> 1 mpg 20.09 (17.92 - 22.26)
#'
#' # Grouped means table
#' # Grouped means table with defaults
#'
#' mtcars %>%
#' group_by(cyl) %>%
#' mean_table(mpg) %>%
#' format_table()
#'
#' #> # A tibble: 3 x 3
#' #> cyl var mean_95
#' #> <dbl> <chr> <chr>
#' #> 1 4 mpg 26.66 (23.63 - 29.69)
#' #> 2 6 mpg 19.74 (18.40 - 21.09)
#' #> 3 8 mpg 15.10 (13.62 - 16.58)
#' #> # A tibble: 3 x 4
#' #> response_var group_var group_cat mean_95
#' #> <chr> <chr> <dbl> <chr>
#' #> 1 mpg cyl 4 26.66 (23.63 - 29.69)
#' #> 2 mpg cyl 6 19.74 (18.40 - 21.09)
#' #> 3 mpg cyl 8 15.10 (13.62 - 16.58)
#'
#' # One-way frequency tables with defaults
#'
#' mtcars %>%
#' group_by(cyl) %>%
#' mean_table(mpg) %>%
#' format_table()
#' #> # A tibble: 2 x 3
#' #> var cat percent_95
#' #> <chr> <dbl> <chr>
#' #> 1 am 0 59.38 (40.94 - 75.50)
#' #> 2 am 1 40.62 (24.50 - 59.06)
#'
#' # Two-way frequency tables with defaults
#'
#' mtcars %>%
#' group_by(am, cyl) %>%
#' freq_table() %>%
#' format_table()
#'
#' #> # A tibble: 6 x 5
#' #> row_var row_cat col_var col_cat percent_row_95
#' #> <chr> <dbl> <chr> <dbl> <chr>
#' #> 1 am 0 cyl 4 15.79 (4.78 - 41.20)
#' #> 2 am 0 cyl 6 21.05 (7.58 - 46.44)
#' #> 3 am 0 cyl 8 63.16 (38.76 - 82.28)
#' #> 4 am 1 cyl 4 61.54 (32.30 - 84.29)
#' #> 5 am 1 cyl 6 23.08 (6.91 - 54.82)
#' #> 6 am 1 cyl 8 15.38 (3.43 - 48.18)
#'
#' #' # Two-way frequency tables with with stats = "n and row percent"
#'
#' mtcars %>%
#' group_by(am, cyl) %>%
#' freq_table(output = all) %>% # Don't forget output = all
#' format_table(stats = "n and row percent")
#'
#' #> # A tibble: 6 x 5
#' #> row_var row_cat col_var col_cat n_percent_row
#' #> <chr> <dbl> <chr> <dbl> <chr>
#' #> 1 am 0 cyl 4 3 (15.79)
#' #> 2 am 0 cyl 6 4 (21.05)
#' #> 3 am 0 cyl 8 12 (63.16)
#' #> 4 am 1 cyl 4 8 (61.54)
#' #> 5 am 1 cyl 6 3 (23.08)
#' #> 6 am 1 cyl 8 2 (15.38)

# =============================================================================
# S3 Generic function
Expand All @@ -88,26 +134,28 @@ format_table.mean_table <- function(.data, digits = 2, stats = "mean and ci", ..
# ------------------------------------------------------------------
# Prevents R CMD check: "no visible binding for global variable ‘.’"
# ------------------------------------------------------------------
lcl = ucl = n = var = mean_95 = n_mean = NULL
lcl = ucl = n = var = mean_95 = n_mean = response_var = NULL

# Format statistics
out <- .data %>%
dplyr::mutate(
mean = format(mean, nsmall = digits),
lcl = format(lcl, nsmall = digits),
lcl = trimws(lcl),
ucl = format(ucl, nsmall = digits),
ucl = trimws(ucl),
mean_95 = paste0(mean, " (", lcl, " - ", ucl, ")"),
n_mean = paste0(n, " (", mean, ")")
)

# Control output
if (stats == "mean and ci") {
out <- out %>%
dplyr::select(var, mean_95)
dplyr::select(response_var, mean_95)

} else if (stats == "n and mean") {
out <- out %>%
dplyr::select(var, n_mean )
dplyr::select(response_var, n_mean )
}

# Return result
Expand All @@ -130,27 +178,31 @@ format_table.mean_table_grouped <- function(.data, digits = 2, stats = "mean and
# ------------------------------------------------------------------
# Prevents R CMD check: "no visible binding for global variable ‘.’"
# ------------------------------------------------------------------
lcl = ucl = n = var = mean_95 = n_mean = NULL
lcl = ucl = n = var = mean_95 = n_mean = sem = NULL


# Format statistics
out <- .data %>%
dplyr::mutate(
mean = format(mean, nsmall = digits),
lcl = format(lcl, nsmall = digits),
lcl = trimws(lcl),
ucl = format(ucl, nsmall = digits),
ucl = trimws(ucl),
mean_95 = paste0(mean, " (", lcl, " - ", ucl, ")"),
n_mean = paste0(n, " (", mean, ")")
)

# Control output
# Dropping everything except the variable names, categories, and
# "mean and ci" or "n and mean"
if (stats == "mean and ci") {
out <- out %>%
dplyr::select(1, var, mean_95)
dplyr::select(-c(n, mean, sem, lcl, ucl, min, max, n_mean))

} else if (stats == "n and mean") {
out <- out %>%
dplyr::select(1, var, n_mean )
dplyr::select(-c(n, mean, sem, lcl, ucl, min, max, mean_95))
}

# Return result
Expand All @@ -173,26 +225,28 @@ format_table.freq_table_one_way <- function(.data, digits = 2, stats = "percent
# ------------------------------------------------------------------
# Prevents R CMD check: "no visible binding for global variable ‘.’"
# ------------------------------------------------------------------
percent = lcl = ucl = n = percent_95 = n_percent = NULL
percent = lcl = ucl = n = percent_95 = n_percent = var = NULL

# Format statistics
out <- .data %>%
dplyr::mutate(
percent = format(percent, nsmall = digits),
lcl = format(lcl, nsmall = digits),
lcl = trimws(lcl),
ucl = format(ucl, nsmall = digits),
ucl = trimws(ucl),
percent_95 = paste0(percent, " (", lcl, " - ", ucl, ")"),
n_percent = paste0(n, " (", percent, ")")
)

# Control output
if (stats == "percent and ci") {
out <- out %>%
dplyr::select(1, percent_95)
dplyr::select(var, cat, percent_95)

} else if (stats == "n and percent") {
out <- out %>%
dplyr::select(1, n_percent )
dplyr::select(var, cat, n_percent )
}

# Return result
Expand All @@ -217,7 +271,7 @@ format_table.freq_table_two_way <- function(.data, digits = 2, stats = "row perc
# ------------------------------------------------------------------
percent_row = lcl_row = ucl_row = n = percent_total = lcl_total = NULL
ucl_total = percent_row_95 = n_percent_row = percent_total_95 = NULL
n_percent_total = NULL
n_percent_total = row_var = row_cat = col_var = col_cat = NULL


# Figure out if .data includes overall percentages or not
Expand All @@ -238,8 +292,10 @@ format_table.freq_table_two_way <- function(.data, digits = 2, stats = "row perc
dplyr::mutate(
percent_row = format(percent_row, nsmall = digits),
lcl_row = format(lcl_row, nsmall = digits),
lcl_row = trimws(lcl_row),
ucl_row = format(ucl_row, nsmall = digits),
percent_row_95 = paste0(percent_row, " (", lcl_row, " - ", ucl_row, ")"),
ucl_row = trimws(ucl_row),
n_percent_row = paste0(n, " (", percent_row, ")")
)

Expand All @@ -250,7 +306,9 @@ format_table.freq_table_two_way <- function(.data, digits = 2, stats = "row perc
dplyr::mutate(
percent_total = format(percent_total, nsmall = digits),
lcl_total = format(lcl_total, nsmall = digits),
lcl_total = trimws(lcl_total),
ucl_total = format(ucl_total, nsmall = digits),
ucl_total = trimws(ucl_total),
percent_total_95 = paste0(percent_total, " (", lcl_total, " - ", ucl_total, ")"),
n_percent_total = paste0(n, " (", percent_total, ")")
)
Expand All @@ -261,23 +319,23 @@ format_table.freq_table_two_way <- function(.data, digits = 2, stats = "row perc
# --------------
if (stats == "row percent and ci") {
out <- out %>%
dplyr::select(1:2, percent_row_95)
dplyr::select(row_var, row_cat, col_var, col_cat, percent_row_95)

} else if (stats == "n and row percent") {
out <- out %>%
dplyr::select(1:2, n_percent_row)
dplyr::select(row_var, row_cat, col_var, col_cat, n_percent_row)

} else if ((stats == "percent and ci" || stats == "n and percent") && !has_overall_percent) {
stop("In order to pass stats = 'percent and ci' or 'n and percent' to format_table ",
"you must first pass 'output = all' to freq_table.")

} else if (stats == "percent and ci" && has_overall_percent) {
out <- out %>%
dplyr::select(1:2, percent_total_95)
dplyr::select(row_var, row_cat, col_var, col_cat, percent_total_95)

} else if (stats == "n and percent" && has_overall_percent) {
out <- out %>%
dplyr::select(1:2, n_percent_total)
dplyr::select(row_var, row_cat, col_var, col_cat, n_percent_total)
}

# Return result
Expand Down
Loading

0 comments on commit a27ed38

Please sign in to comment.