#' Reshape estimations with multiple iterations (draws) to long format
#'
#' Reshape a wide data.frame of iterations (such as posterior draws or
#' bootsrapped samples) as columns to long format. Instead of having all
#' iterations as columns (e.g., `iter_1, iter_2, ...`), will return 3 columns
#' with the `\*_index` (the previous index of the row), the `\*_group` (the
#' iteration number) and the `\*_value` (the value of said iteration).
#'
#' @param x A data.frame containing posterior draws obtained from
#' `estimate_response` or `estimate_link`.
#' @param prefix The prefix of the draws (for instance, `"iter_"` for columns
#' named as `iter_1, iter_2, iter_3`). If more than one are provided, will
#' search for the first one that matches.
#' @examples
#' \donttest{
#' if (require("rstanarm")) {
#' model <- stan_glm(mpg ~ am, data = mtcars, refresh = 0)
#' draws <- insight::get_predicted(model)
#' long_format <- reshape_iterations(draws)
#' head(long_format)
#' }
#' }
#' @return Data frame of reshaped draws in long format.
#' @export
reshape_iterations <- function(x, prefix = c("draw", "iter", "iteration", "sim")) {
# Accomodate output from get_predicted
if (inherits(x, "get_predicted") && "iterations" %in% names(attributes(x))) {
x <- as.data.frame(x)
}
# Find columns' name
prefix <- prefix[min(which(sapply(tolower(prefix), function(prefix) sum(grepl(prefix, tolower(names(x)), fixed = TRUE)) > 1)))]
if (is.na(prefix) || is.null(prefix)) {
insight::format_error(
"Couldn't find columns corresponding to iterations in your dataframe, please specify the correct prefix."
)
}
# Get column names
iter_cols <- tolower(names(x))[grepl(prefix, tolower(names(x)), fixed = TRUE)]
# Drop "_" if prefix ends with it
newname <- ifelse(endsWith(prefix, "_"), substr(prefix, 1, nchar(prefix) - 1), prefix)
# Create Index column
index_col <- paste0(newname, "_index")
if (index_col %in% names(x)) index_col <- paste0(".", newname, "_index")
x[[index_col]] <- seq_len(nrow(x))
# Reshape
long <- stats::reshape(x,
varying = iter_cols,
idvar = index_col,
v.names = paste0(newname, "_value"),
timevar = paste0(newname, "_group"),
direction = "long"
)
row.names(long) <- NULL
class(long) <- class(long)[which(inherits(long, "data.frame")):length(class(long))]
long
}
#' @rdname reshape_iterations
#' @export
reshape_draws <- function(x, prefix = c("draw", "iter", "iteration", "sim")) {
.Deprecated("reshape_iterations")
reshape_iterations(x, prefix)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.