From 79d4521b943e44f4ac31636c4488d9e2cfeac3ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul-Christian=20B=C3=BCrkner?= Date: Mon, 2 Dec 2024 23:36:33 +0100 Subject: [PATCH] Convert lists of matrices to `draws_array` objects --- DESCRIPTION | 4 ++-- NEWS.md | 6 ++++++ R/as_draws.R | 9 +++++---- R/as_draws_array.R | 15 +++++++++++++-- tests/testthat/test-as_draws.R | 13 +++++++++++++ 5 files changed, 39 insertions(+), 8 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a6289bf4..7c5ef3d5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: posterior Title: Tools for Working with Posterior Distributions -Version: 1.6.0 -Date: 2024-06-28 +Version: 1.6.0.9000 +Date: 2024-12-02 Authors@R: c(person("Paul-Christian", "Bürkner", email = "paul.buerkner@gmail.com", role = c("aut", "cre")), person("Jonah", "Gabry", email = "jsg2201@columbia.edu", role = c("aut")), person("Matthew", "Kay", email = "mjskay@northwestern.edu", role = c("aut")), diff --git a/NEWS.md b/NEWS.md index 7ae17cd6..0ca3d523 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,9 @@ +# posterior 1.6.0+ + +### Enhancements + +* Convert lists of matrices to `draws_array` objects. + # posterior 1.6.0 ### Enhancements diff --git a/R/as_draws.R b/R/as_draws.R index c52e75a5..84c4e669 100644 --- a/R/as_draws.R +++ b/R/as_draws.R @@ -76,10 +76,11 @@ closest_draws_format <- function(x) { out <- "rvars" } else if (is_draws_list_like(x)) { out <- "list" - } - else { - stop_no_call("Don't know how to transform an object of class ", - "'", class(x)[1L], "' to any supported draws format.") + } else { + stop_no_call( + "Don't know how to transform an object of class '", + class(x)[1L], "' to any supported draws format." + ) } paste0("draws_", out) } diff --git a/R/as_draws_array.R b/R/as_draws_array.R index 8ed9a529..63724f7c 100644 --- a/R/as_draws_array.R +++ b/R/as_draws_array.R @@ -130,7 +130,11 @@ as_draws_array.mcmc.list <- function(x, ...) { # try to convert any R object into a 'draws_array' object .as_draws_array <- function(x) { - x <- as.array(x) + if (is_matrix_list_like(x)) { + x <- as_array_matrix_list(x) + } else { + x <- as.array(x) + } new_dimnames <- list(iteration = NULL, chain = NULL, variable = NULL) if (!is.null(dimnames(x)[[3]])) { new_dimnames[[3]] <- dimnames(x)[[3]] @@ -177,7 +181,14 @@ is_draws_array <- function(x) { # is an object looking like a 'draws_array' object? is_draws_array_like <- function(x) { - is.array(x) && length(dim(x)) == 3L + is.array(x) && length(dim(x)) == 3L || + is_matrix_list_like(x) +} + +# is an object likely a list of matrices? +# such an object can be easily converted to a draws_array +is_matrix_list_like <- function(x) { + is.list(x) && length(dim(x[[1]])) == 2L } #' Extract parts of a `draws_array` object diff --git a/tests/testthat/test-as_draws.R b/tests/testthat/test-as_draws.R index f33720ae..a1b422f7 100644 --- a/tests/testthat/test-as_draws.R +++ b/tests/testthat/test-as_draws.R @@ -127,6 +127,19 @@ test_that("arrays can be transformed to draws_array objects", { expect_equal(nchains(y), 4) }) +test_that("lists of matrices can be transformed to draws_array objects", { + x <- round(rnorm(200), 2) + x <- matrix(x, nrow = 50) + colnames(x) <- paste0("theta", 1:4) + x <- list(x, x, x) + + y <- as_draws(x) + expect_is(y, "draws_array") + expect_equal(variables(y), colnames(x[[1]])) + expect_equal(niterations(y), 50) + expect_equal(nchains(y), 3) +}) + test_that("data.frames can be transformed to draws_df objects", { x <- data.frame( v1 = rnorm(100),