From 8675bc110300bb719913b04cd4fca7102fa43dec Mon Sep 17 00:00:00 2001 From: Sean Anderson Date: Thu, 22 Feb 2024 12:25:21 -0800 Subject: [PATCH] Add CV note in docs --- R/cross-val.R | 6 ++++-- man/sdmTMB_cv.Rd | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/R/cross-val.R b/R/cross-val.R index 0fe2c7887..0648e406a 100644 --- a/R/cross-val.R +++ b/R/cross-val.R @@ -113,8 +113,10 @@ ll_sdmTMB <- function(object, withheld_y, withheld_mu) { #' * `data`: Original data plus columns for fold ID, CV predicted value, #' and CV log likelihood. #' * `models`: A list of models; one per fold. -#' * `fold_loglik`: Sum of left-out log likelihoods per fold. -#' * `sum_loglik`: Sum of `fold_loglik` across all left-out data. +#' * `fold_loglik`: Sum of left-out log likelihoods per fold. More positive +#' values are better. +#' * `sum_loglik`: Sum of `fold_loglik` across all left-out data. More positive +#' values are better. #' * `pdHess`: Logical vector: Hessian was invertible each fold? #' * `converged`: Logical: all `pdHess` `TRUE`? #' * `max_gradients`: Max gradient per fold. diff --git a/man/sdmTMB_cv.Rd b/man/sdmTMB_cv.Rd index 62d74a5f0..4b60e1a39 100644 --- a/man/sdmTMB_cv.Rd +++ b/man/sdmTMB_cv.Rd @@ -76,8 +76,10 @@ A list: \item \code{data}: Original data plus columns for fold ID, CV predicted value, and CV log likelihood. \item \code{models}: A list of models; one per fold. -\item \code{fold_loglik}: Sum of left-out log likelihoods per fold. -\item \code{sum_loglik}: Sum of \code{fold_loglik} across all left-out data. +\item \code{fold_loglik}: Sum of left-out log likelihoods per fold. More positive +values are better. +\item \code{sum_loglik}: Sum of \code{fold_loglik} across all left-out data. More positive +values are better. \item \code{pdHess}: Logical vector: Hessian was invertible each fold? \item \code{converged}: Logical: all \code{pdHess} \code{TRUE}? \item \code{max_gradients}: Max gradient per fold.