feat: Added an mcmcglm method for "coef" function

mathiaslj · Dec 8, 2024 · 97431ba · 97431ba
1 parent ab415c5
commit 97431ba
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 1 deletion.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(coef,mcmcglm)
 S3method(log_density,NegativeBinomial)
 S3method(log_density,binomial)
 S3method(log_density,gaussian)

diff --git a/R/mcmcglm_methods.R b/R/mcmcglm_methods.R
@@ -22,6 +22,15 @@ samples.mcmcglm <- function(x) {
   x$beta_samples
 }
 
+#' S3 method for getting the average value of coefficients
+#'
+#' @param x an `mcmcglm` object
+#'
+#' @export
+coef.mcmcglm <- function(x) {
+  x$beta_mean
+}
+
 #' Create a trace plot of the MCMC samples
 #'
 #' @inheritParams samples

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -20,6 +20,7 @@ reference:
   desc: >
     Methods to explore results - data of samples and function for creating trace plot
   contents:
+  - coef.mcmcglm
   - samples
   - trace_plot
 - subtitle: Tuning parameters of slice sampling

diff --git a/man/coef.mcmcglm.Rd b/man/coef.mcmcglm.Rd
diff --git a/vignettes/performance.Rmd b/vignettes/performance.Rmd
@@ -26,7 +26,7 @@ withr::local_seed(42)
 ### Using default slice function
 ```{r run-compare-nvars}
 res <- compare_eta_comptime_across_nvars(
-  n_vars = c(2, seq(from = 10, to = 60, by = 10)),
+  n_vars = c(2, seq(from = 500, to = 1000, by = 500)),
   n_samples = 10,
   burnin = 1,
   w = 0.5,