#' Plot sample sizes
#'
#' @description `r lifecycle::badge("deprecated")`
#' This function is deprecated because the new version of specr uses a new analytic framework.
#' In this framework, you can plot a similar figure simply by using the generic \code{plot()}
#' function and adding the argument \code{type = "samplesizes"}. This function plots a histogram
#' of sample sizes per specification. It can be added to the overall specification curve
#' plot (see vignettes).
#'
#' @param df a data frame resulting from \code{run_specs()}.
#' @param var which variable should be evaluated? Defaults to estimate (the effect sizes computed by [run_specs()]).
#' @param group Should the arrangement of the curve be grouped by a particular choice?
#' Defaults to NULL, but can be any of the present choices (e.g., x, y, controls...)
#' @param desc logical value indicating whether the curve should the arranged in a descending order. Defaults to FALSE.
#'
#' @return a \link[ggplot2]{ggplot} object.
#'
#' @export
#'
#' @examples
#' # load additional library
#' library(ggplot2) # for further customization of the plots
#'
#' # run specification curve analysis
#' results <- run_specs(df = example_data,
#' y = c("y1", "y2"),
#' x = c("x1", "x2"),
#' model = c("lm"),
#' controls = c("c1", "c2"),
#' subsets = list(group1 = unique(example_data$group1),
#' group2 = unique(example_data$group2)))
#' # plot ranked bar chart of sample sizes
#' plot_samplesizes(results)
#'
#' # add a horizontal line for the median sample size
#' plot_samplesizes(results) +
#' geom_hline(yintercept = median(results$fit_nobs),
#' color = "darkgrey",
#' linetype = "dashed") +
#' theme_linedraw()
plot_samplesizes <- function(df,
var = .data$estimate,
group = NULL,
desc = FALSE) {
# Deprecation warning
lifecycle::deprecate_warn("1.0.0", "plot_samplesizes()", "plot.specr.object()")
var <- enquo(var)
group <- enquo(group)
df %>%
format_results(var = var, group = group, desc = desc) %>%
ggplot(aes(x = .data$specifications,
y = .data$fit_nobs)) +
geom_bar(stat = "identity",
fill = "grey",
size = .2) +
theme_minimal() +
theme(
axis.line = element_line("black", size = .5),
legend.position = "none",
panel.spacing = unit(.75, "lines"),
axis.text = element_text(colour = "black")) +
labs(x = "", y = "")
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.