From 28c3f0f86e69393043bd44b7c10a4b8145152848 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul-Christian=20B=C3=BCrkner?= Date: Fri, 15 Nov 2024 09:48:23 +0100 Subject: [PATCH] minor doc cleaning --- R/kfold.R | 8 ++++---- man/kfold.brmsfit.Rd | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/R/kfold.R b/R/kfold.R index 33d5b02b6..3900af6af 100644 --- a/R/kfold.R +++ b/R/kfold.R @@ -33,10 +33,10 @@ #' @param joint Indicates which observations' log likelihoods shall be #' considered jointly in the ELPD computation. If \code{"obs"} or \code{FALSE} #' (the default), each observation is considered separately. This enables -#' comparability of \code{kfold} with \code{loo}. If \code{"fold"}, the joint -#' log likelihoods per fold are used. If \code{"group"}, the joint log -#' likelihoods per group within folds are used (only available if argument -#' \code{group} is specified). +#' comparability of \code{kfold} with \code{loo}. If \code{"fold"} or +#' \code{TRUE}, the joint log likelihoods per fold are used. If +#' \code{"group"}, the joint log likelihoods per group within folds are used +#' (only available if argument \code{group} is specified). #' @param save_fits If \code{TRUE}, a component \code{fits} is added to #' the returned object to store the cross-validated \code{brmsfit} #' objects and the indices of the omitted observations for each fold. diff --git a/man/kfold.brmsfit.Rd b/man/kfold.brmsfit.Rd index df6e122ce..68b5f34c3 100644 --- a/man/kfold.brmsfit.Rd +++ b/man/kfold.brmsfit.Rd @@ -56,10 +56,10 @@ More information is provided in the 'Details' section.} \item{joint}{Indicates which observations' log likelihoods shall be considered jointly in the ELPD computation. If \code{"obs"} or \code{FALSE} (the default), each observation is considered separately. This enables -comparability of \code{kfold} with \code{loo}. If \code{"fold"}, the joint -log likelihoods per fold are used. If \code{"group"}, the joint log -likelihoods per group within folds are used (only available if argument -\code{group} is specified).} +comparability of \code{kfold} with \code{loo}. If \code{"fold"} or +\code{TRUE}, the joint log likelihoods per fold are used. If +\code{"group"}, the joint log likelihoods per group within folds are used +(only available if argument \code{group} is specified).} \item{compare}{A flag indicating if the information criteria of the models should be compared to each other