docs: add documentation for chromPeakSummary generic

sneumann · Sep 18, 2024 · e5aa3ff · e5aa3ff
1 parent 188541c
commit e5aa3ff
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/R/AllGenerics.R b/R/AllGenerics.R
@@ -551,6 +551,15 @@ setGeneric("chromPeakSpectra", function(object, ...)
 #'
 #' Currently implemented methods/parameter classes are:
 #'
+#'
+#' @param object an *xcms* result object containing information on
+#'     identified chromatographic peaks.
+#'
+#' @param param a parameter object defining the method/summaries that should
+#'     be calculated (see description above for supported parameter classes).
+#'
+#' @param ... additional arguments passed to the method implementation.
+#'
 #' @return
 #'
 #' A `matrix` or `data.frame` with the same number of rows as there are

diff --git a/man/chromPeakSummary.Rd b/man/chromPeakSummary.Rd