Skip to content

Commit 5aa92bf

Browse files
authored
Merge pull request #833 from stan-dev/link-to-diagnose-doc
add missing link to diagnose method in CmdStanModel doc
2 parents 41eaee1 + 2b096f5 commit 5aa92bf

6 files changed

Lines changed: 42 additions & 15 deletions

File tree

R/model.R

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,12 @@ cmdstan_model <- function(stan_file = NULL, exe_file = NULL, compile = TRUE, ...
190190
#' [`$save_hpp_file()`][model-method-compile] | Save the `.hpp` file containing the generated C++ code. |
191191
#' [`$expose_functions()`][model-method-expose_functions] | Expose Stan functions for use in R. |
192192
#'
193+
#' ## Diagnostics
194+
#'
195+
#' |**Method**|**Description**|
196+
#' |:----------|:---------------|
197+
#' [`$diagnose()`][model-method-diagnose] | Run CmdStan's `"diagnose"` method to test gradients, return [`CmdStanDiagnose`] object. |
198+
#'
193199
#' ## Model fitting
194200
#'
195201
#' |**Method**|**Description**|

docs/reference/CmdStanModel-1.png

-3 KB
Loading

docs/reference/CmdStanModel-2.png

-3.07 KB
Loading

docs/reference/CmdStanModel.html

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

docs/reference/Rplot001.png

3.93 KB
Loading

man/CmdStanModel.Rd

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

0 commit comments

Comments
 (0)