Merge pull request #833 from stan-dev/link-to-diagnose-doc

add missing link to diagnose method in CmdStanModel doc
stan-dev · Aug 25, 2023 · 5aa92bf · 5aa92bf
2 parents 41eaee1 + 2b096f5
commit 5aa92bf
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 15 deletions.
diff --git a/R/model.R b/R/model.R
@@ -190,6 +190,12 @@ cmdstan_model <- function(stan_file = NULL, exe_file = NULL, compile = TRUE, ...
 #'  [`$save_hpp_file()`][model-method-compile] |  Save the `.hpp` file containing the generated C++ code. |
 #'  [`$expose_functions()`][model-method-expose_functions] |  Expose Stan functions for use in R. |
 #'
+#'  ## Diagnostics
+#'
+#'  |**Method**|**Description**|
+#'  |:----------|:---------------|
+#'  [`$diagnose()`][model-method-diagnose] |  Run CmdStan's `"diagnose"` method to test gradients, return [`CmdStanDiagnose`] object. |
+#'
 #'  ## Model fitting
 #'
 #'  |**Method**|**Description**|

diff --git a/docs/reference/CmdStanModel-1.png b/docs/reference/CmdStanModel-1.png
diff --git a/docs/reference/CmdStanModel-2.png b/docs/reference/CmdStanModel-2.png
diff --git a/docs/reference/CmdStanModel.html b/docs/reference/CmdStanModel.html
diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png
diff --git a/man/CmdStanModel.Rd b/man/CmdStanModel.Rd