From 9a196b5fd2200356c2334eec1d7bcd0159669abd Mon Sep 17 00:00:00 2001 From: Ethan Bass Date: Tue, 12 Dec 2023 12:52:24 -0500 Subject: [PATCH] docs: (read_shimadzu) add collapse argument --- R/read_shimadzu_ascii.R | 7 +++++-- man/read_shimadzu.Rd | 8 ++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/R/read_shimadzu_ascii.R b/R/read_shimadzu_ascii.R index cc86267..c3180cf 100644 --- 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 index a1afb20..f685e12 100644 --- a/man/read_shimadzu.Rd +++ b/man/read_shimadzu.Rd @@ -39,10 +39,14 @@ read_shimadzu( \item{metadata_format}{Format to output metadata. Either \code{chromconverter} or \code{raw}.} + +\item{collapse}{Whether to collapse lists that only contain a single element.} } \value{ -A chromatogram in the format specified by \code{format_out} -(retention time x wavelength). +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). } \description{ Reads 'Shimadzu' ascii files into R. These files are exported from