Skip to content

Commit

Permalink
Add xrefs in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
richfitz committed Nov 6, 2024
1 parent da9b115 commit a343671
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 36 deletions.
24 changes: 12 additions & 12 deletions R/sample.R
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,23 @@
##' @param burnin Number of steps to discard as burnin. This affects
##' only the recording of steps as your chains run; we don't record
##' the first `burnin` steps. Generally you would want to do this
##' in post-processing as this data is discarded with no chance of
##' getting it back. However, if your observation process creates a
##' large amount of data, then you may prefer to apply a burnin here
##' to reduce how much memory is used.
##' in post-processing with [monty_samples_thin()] as this data is
##' discarded with no chance of getting it back. However, if your
##' observation process creates a large amount of data, then you may
##' prefer to apply a burnin here to reduce how much memory is used.
##'
##' @param thinning_factor A thinning factor to apply while the chain
##' is running. If given, then we save every `thinning_factor`'th
##' step. So if `thinning_factor = 2` we save every second step,
##' and if 10, we'd save every 10th. Like `burnin` above, it is
##' preferable to apply this in post processing. However, for
##' slow-mixing chains that have a large observer output you can use
##' this to reduce the memory usage. Use of `thinning_factor`
##' requires that `n_steps` is an even multiple of
##' `thinning_factor`; so if `thinning_factor` is 10, then `n_steps`
##' must be a multiple of 10. This ensures that the last step is in
##' the sample. The thinning factor cannot be changed when
##' continuing a chain.
##' preferable to apply this in post processing with
##' [monty_samples_thin()]. However, for slow-mixing chains that
##' have a large observer output you can use this to reduce the
##' memory usage. Use of `thinning_factor` requires that `n_steps`
##' is an even multiple of `thinning_factor`; so if
##' `thinning_factor` is 10, then `n_steps` must be a multiple of
##' 10. This ensures that the last step is in the sample. The
##' thinning factor cannot be changed when continuing a chain.
##'
##' @return A list of parameters and densities. We provide conversion
##' to formats used by other packages, notably
Expand Down
24 changes: 12 additions & 12 deletions man/monty_sample.Rd

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

24 changes: 12 additions & 12 deletions man/monty_sample_manual_prepare.Rd

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

0 comments on commit a343671

Please sign in to comment.