Merge pull request #640 from stan-dev/temporarily-disable-rvars

temporarily disable rvars

Author: jgabry

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: cmdstanr
 Title: R Interface to 'CmdStan'
-Version: 0.5.0
-Date: 2022-03-17
+Version: 0.5.1
+Date: 2022-04-06
 Authors@R: 
     c(person(given = "Jonah", family = "Gabry", role = c("aut", "cre"),
            email = "[email protected]"),

NEWS.md

@@ -1,3 +1,9 @@
+# cmdstanr 0.5.1
+
+* Temporarily disable `format="draws_rvars"` in the `$draws()` method due to a
+bug. Until this is fixed users can make use of `posterior::as_draws_rvars()` to
+convert draws from CmdStanR to the `draws_rvars` format. (#640)
+
 # cmdstanr 0.5.0
 
 ### Bug fixes

R/fit.R

@@ -823,6 +823,7 @@ CmdStanFit$set("public", name = "code", value = code)
 #'
 #'  |**Method**|**Description**|
 #'  |:----------|:---------------|
+#'  [`$print()`][fit-method-print] |  Run [`posterior::summarise_draws()`][posterior::draws_summary]. |
 #'  [`$summary()`][fit-method-summary] |  Run [`posterior::summarise_draws()`][posterior::draws_summary]. |
 #'  [`$diagnostic_summary()`][fit-method-diagnostic_summary] |  Get summaries of sampler diagnostics and warning messages. |
 #'  [`$cmdstan_summary()`][fit-method-cmdstan_summary] |  Run and print CmdStan's `bin/stansummary`. |

R/utils.R

@@ -356,12 +356,19 @@ as_draws_format_fun <- function(draws_format) {
 }
 
 assert_valid_draws_format <- function(format) {
-  if (!is.null(format) &&
-      !format %in% valid_draws_formats()) {
-    stop(
-      "The supplied draws format is not valid. ",
-      call. = FALSE
-    )
+  if (!is.null(format)) {
+    if (!format %in% valid_draws_formats()) {
+      stop(
+        "The supplied draws format is not valid. ",
+        call. = FALSE
+      )
+    }
+    if (format %in% c("rvars", "draws_rvars")) {
+      stop(
+        "\nWe are fixing a bug in fit$draws(format = 'draws_rvars').",
+        "\nFor now please use posterior::as_draws_rvars(fit$draws()) instead."
+      )
+    }
   }
   invisible(format)
 }

man/CmdStanMCMC.Rd

@@ -46,7 +46,7 @@ data {
   int<lower=1> k;
   int<lower=0> n;
   matrix[n, k] X;
-  int y[n];
+  array[n] int y;
 }
 parameters {
   vector[k] beta;
@@ -84,7 +84,7 @@ data {
   int<lower=1> k;
   int<lower=0> n;
   matrix[n, k] X;
-  int y[n];
+  array[n] int y;
 }
 parameters {
   vector[k] beta;
@@ -157,7 +157,7 @@ data {
   int<lower=1> k;
   int<lower=0> n;
   matrix[n, k] X;
-  int y[n];
+  array[n] int y;
 }
 parameters {
   vector[k] beta;