Merge pull request #48 from osorensen/copilot/add-simple-example-compute-sequentially

osorensen · web-flow · commit 285136f8c355 · 2026-01-21T11:18:07.000+01:00
Add example to compute_sequentially() documentation
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,6 @@
 .Rhistory
 .RData
 .Ruserdata
-parameter_trace
+parameter_trace
+*.Rcheck
+*.tar.gz
diff --git a/R/compute_sequentially.R b/R/compute_sequentially.R
@@ -32,6 +32,14 @@
 #' @return An object of class BayesMallowsSMC2.
 #' @export
 #'
+#' @examples
+#' # Compute the model sequentially with complete rankings
+#' mod <- compute_sequentially(
+#'   complete_rankings,
+#'   hyperparameters = set_hyperparameters(n_items = 5),
+#'   smc_options = set_smc_options(n_particles = 100, n_particle_filters = 1)
+#' )
+#'
 compute_sequentially <- function(
     data,
     hyperparameters = set_hyperparameters(),
diff --git a/man/compute_sequentially.Rd b/man/compute_sequentially.Rd
