Skip to content

Commit fcee400

Browse files
Copilotosorensen
andcommitted
Use Rdpack for references and remove tau example from trace_plot documentation
Co-authored-by: osorensen <21175639+osorensen@users.noreply.github.com>
1 parent aa23526 commit fcee400

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

DESCRIPTION

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@ LinkingTo:
2424
RcppArmadillo
2525
Imports:
2626
Rcpp,
27-
ggplot2
27+
ggplot2,
28+
Rdpack
2829
Depends:
2930
R (>= 4.1.0)
3031
Suggests:
3132
testthat (>= 3.0.0),
3233
label.switching (>= 1.8)
34+
RdMacros: Rdpack
3335
Config/testthat/edition: 3

R/trace_plot.R

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' Visualize the timeseries dynamics of the alpha and tau parameters across
44
#' timepoints. This function creates trace plots similar to Figure 4 (left) in
5-
#' Sørensen (2025).
5+
#' \insertRef{10.1214/25-BA1564}{BayesMallowsSMC2}.
66
#'
77
#' @param x An object of class `BayesMallowsSMC2`, returned from
88
#' [compute_sequentially()] with `trace = TRUE` in [set_smc_options()].
@@ -33,6 +33,9 @@
3333
#'
3434
#' @export
3535
#'
36+
#' @references
37+
#' \insertRef{10.1214/25-BA1564}{BayesMallowsSMC2}
38+
#'
3639
#' @examples
3740
#' \dontrun{
3841
#' # Fit a model with trace enabled
@@ -48,9 +51,6 @@
4851
#'
4952
#' # Create trace plot for alpha (default)
5053
#' trace_plot(mod)
51-
#'
52-
#' # Create trace plot for tau
53-
#' trace_plot(mod, parameter = "tau")
5454
#' }
5555
trace_plot <- function(x, parameter = "alpha", ...) {
5656
# Validate parameter

man/trace_plot.Rd

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)