Skip to content

Clarify MCMC-nuts chain argument documentation for mcmc_nuts_stepsize(). #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jgabry merged 1 commit into from
Jan 5, 2026
Merged

Clarify MCMC-nuts chain argument documentation for mcmc_nuts_stepsize(). #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions R/mcmc-diagnostics-nuts.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@
#' @param chain A positive integer for selecting a particular chain. The default
#' (`NULL`) is to merge the chains before plotting. If `chain = k`
#' then the plot for chain `k` is overlaid (in a darker shade but with
#' transparency) on top of the plot for all chains. The `chain` argument
#' is not used by `mcmc_nuts_energy()`.
#' transparency) on top of the plot for all chains. For `mcmc_nuts_stepsize()`,
#' chains are always plotted separately, and `chain` simply highlights the
#' selected chain. The `chain` argument is not used by `mcmc_nuts_energy()`.
#' @param ... Currently ignored.
#'
#' @return A gtable object (the result of calling
Expand Down Expand Up @@ -285,7 +286,6 @@ mcmc_nuts_divergence <- function(x, lp, chain = NULL, ...) {
as_bayesplot_grid(nuts_plot)
}


#' @rdname MCMC-nuts
#' @export
mcmc_nuts_stepsize <- function(x, lp, chain = NULL, ...) {
Expand Down
5 changes: 3 additions & 2 deletions man/MCMC-nuts.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.