aboutsummaryrefslogtreecommitdiff
path: root/R/mmkin.R
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2020-04-07 16:17:20 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2020-04-07 16:17:20 +0200
commitc12aba04c7fdc745dec51ae5d640d8013c99b4dd (patch)
tree58a59d4abdd99736754cb19f580947ae021bdd77 /R/mmkin.R
parenta98733db782ce3e9446dda187c34703f61916806 (diff)
Improve documentation of mmkin objects
Diffstat (limited to 'R/mmkin.R')
-rw-r--r--R/mmkin.R5
1 files 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.

Contact - Imprint