docs: (read_shimadzu) add collapse argument

ethanbass · Dec 12, 2023 · 9a196b5 · 9a196b5
1 parent 9ed3eec
commit 9a196b5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/R/read_shimadzu_ascii.R b/R/read_shimadzu_ascii.R
@@ -20,8 +20,11 @@
 #' @param read_metadata Whether to read metadata from file.
 #' @param metadata_format Format to output metadata. Either \code{chromconverter} or
 #' \code{raw}.
-#' @return A chromatogram in the format specified by \code{format_out}
-#' (retention time x wavelength).
+#' @param collapse Whether to collapse lists that only contain a single element.
+#' @return A nested list of elements from the specified \code{file}, where the
+#' top levels are chromatograms, peak tables, and/or mass spectra according to
+#' the value of \code{what}. Chromatograms are returned in the format specified
+#' by \code{format_out} (retention time x wavelength).
 #' @author Ethan Bass
 #' @export
 

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