diff options
author | Johannes Ranke <jranke@uni-bremen.de> | 2020-04-07 16:17:20 +0200 |
---|---|---|
committer | Johannes Ranke <jranke@uni-bremen.de> | 2020-04-07 16:17:20 +0200 |
commit | c12aba04c7fdc745dec51ae5d640d8013c99b4dd (patch) | |
tree | 58a59d4abdd99736754cb19f580947ae021bdd77 /R | |
parent | a98733db782ce3e9446dda187c34703f61916806 (diff) |
Improve documentation of mmkin objects
Diffstat (limited to 'R')
-rw-r--r-- | R/mmkin.R | 5 |
1 files changed, 3 insertions, 2 deletions
@@ -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. |