warn on tidy_optim standard error (closes #529)

tidymodels · Jun 2, 2020 · 9645c58 · 9645c58
1 parent 839a287
commit 9645c58
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/R/list-optim-tidiers.R b/R/list-optim-tidiers.R
@@ -16,6 +16,11 @@
 #' f <- function(x) (x[1] - 2)^2 + (x[2] - 3)^2 + (x[3] - 8)^2
 #' o <- optim(c(1, 1, 1), f)
 #'
+#' @note 
+#' This function assumes that the provided objective function is a negative 
+#' log-likelihood function. Results will be invalid if an incorrect
+#' function is supplied.
+#'
 #' tidy(o)
 #' glance(o)
 #' @aliases optim_tidiers tidy.optim

diff --git a/man/tidy_optim.Rd b/man/tidy_optim.Rd