Clarify how getPlottingData() nests elements per modelID for multiModel plots

Author: jdblischak

R/plots.R

@@ -341,11 +341,6 @@ getMappingPlottingData <- function(study = study, modelID = modelID, featureID =
 #'   order of this input. The column order is unchanged. If multiple testIDs are
 #'   provided, they are stored in a list object.}
 #'
-#' If multiple models are passed:
-#'
-#'   \item{\code{mapping}}{A data frame that contains the featureID(s) from each
-#'   model. This is the filtered mapping object.}
-#'
 #' If the study has metaAssays available that map to the input featureID(s),
 #' then \code{metaFeatures} and \code{metaAssays} are returned:
 #'
@@ -369,6 +364,14 @@ getMappingPlottingData <- function(study = study, modelID = modelID, featureID =
 #'   \item{\code{objects}}{A custom object that was added to the modelID
 #'   (\code{\link{addObjects}})}
 #'
+#' If multiple models are passed, then the top-level elements correspond to the
+#' names of the modelIDs, and the above elements are each nested within their
+#' respective modelID. Furthermore, an additional top-level element
+#' \code{mapping} is returned:
+#'
+#'   \item{\code{mapping}}{A data frame that contains the featureID(s) from each
+#'   model. This is the filtered mapping object.}
+#'
 #' @seealso \code{\link{addPlots}}, \code{\link{plotStudy}}
 #'
 #' @export