From c12aba04c7fdc745dec51ae5d640d8013c99b4dd Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Tue, 7 Apr 2020 16:17:20 +0200 Subject: Improve documentation of mmkin objects --- R/mmkin.R | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/R/mmkin.R b/R/mmkin.R index 39eb5740..dbb61b78 100644 --- a/R/mmkin.R +++ b/R/mmkin.R @@ -17,8 +17,9 @@ #' for parallel execution. #' @param \dots Further arguments that will be passed to \code{\link{mkinfit}}. #' @importFrom parallel mclapply parLapply detectCores -#' @return A matrix of \code{\link{mkinfit}} objects that can be indexed using -#' the model and dataset names as row and column indices. +#' @return A two-dimensional \code{\link{array}} of \code{\link{mkinfit}} +#' objects that can be indexed using the model names for the first index (row index) +#' and the dataset names for the second index (column index). #' @author Johannes Ranke #' @seealso \code{\link{[.mmkin}} for subsetting, \code{\link{plot.mmkin}} for #' plotting. -- cgit v1.2.1