docs: ms_format argument in read_shimadzu

ethanbass · Dec 18, 2023 · b165dfc · b165dfc
1 parent ee90c1f
commit b165dfc
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/R/read_cdf.R b/R/read_cdf.R
@@ -130,7 +130,7 @@ read_andi_chrom <- function(file, format_out = c("matrix", "data.frame"),
 #' @param metadata_format Format to output metadata. Either \code{chromconverter}
 #' or \code{raw}.
 #' @param ms_format Whether to return mass spectral data as a (long)
-#' \code{data.frame} or a list.
+#' \code{data.frame} or a \code{list}.
 #' @return A chromatogram in the format specified by the \code{format_out} and
 #' \code{data_format} arguments (retention time x wavelength).
 #' @author Ethan Bass

diff --git a/R/read_shimadzu_ascii.R b/R/read_shimadzu_ascii.R
@@ -20,6 +20,8 @@
 #' @param read_metadata Whether to read metadata from file.
 #' @param metadata_format Format to output metadata. Either \code{chromconverter} or
 #' \code{raw}.
+#' @param ms_format Whether to return mass spectral data as a (long)
+#' \code{data.frame} or a \code{list}.
 #' @param collapse Logical. Whether to collapse lists that only contain a single
 #' element.
 #' @return A nested list of elements from the specified \code{file}, where the

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