docs: infinitesimal changes to formatting

Author: ethanbass

R/call_entab.R

@@ -2,7 +2,7 @@
 #'
 #' Converts chromatography date files using [entab](https://github.com/bovee/entab) parsers.
 #'
-#' @param path Path to file
+#' @param path Path to file.
 #' @param data_format Whether to return data in \code{wide} or \code{long} format.
 #' @param format_out Class of output. Either \code{matrix}, \code{data.frame},
 #' or \code{data.table}.

R/call_rainbow.R

@@ -8,7 +8,7 @@
 #' \code{"chemstation_uv"} a \code{.uv} file should be provided. Data can be filtered
 #' by detector type using the \code{what} argument.
 #'
-#' @param path Path to file
+#' @param path Path to file.
 #' @param format_in Format of the supplied files. Either \code{agilent_d},
 #' \code{waters_raw}, or \code{chemstation}.
 #' @param format_out R format. Either \code{matrix}, \code{data.frame}, or

R/read_agilent_d.R

@@ -2,7 +2,7 @@
 #'
 #' Reads files from 'Agilent' \code{.D} directories.
 #'
-#' @param path Path to \code{.ch} file
+#' @param path Path to \code{.D} directory.
 #' @param what Whether to extract chromatograms (\code{chroms}), DAD data
 #' (\code{dad}) and/or peak tables \code{peak_table}. Accepts multiple arguments.
 #' \code{ms_spectra}. Accepts multiple arguments.

R/read_chemstation_ch.R

@@ -10,7 +10,7 @@
 #' ionization (FID) detectors.
 #'
 #' @importFrom bitops bitAnd bitShiftL
-#' @param path Path to \code{.ch} file
+#' @param path Path to \code{.ch} file.
 #' @param format_out Class of output. Either \code{matrix}, \code{data.frame},
 #' or \code{data.table}.
 #' @param data_format Whether to return data in \code{wide} or \code{long} format.

R/read_chemstation_csv.R

@@ -6,7 +6,7 @@
 #'
 #' @name read_chemstation_csv
 #' @importFrom utils tail read.csv
-#' @param path Path to file
+#' @param path Path to Agilent \code{.csv} file.
 #' @param format_out Class of output. Either \code{matrix}, \code{data.frame},
 #' or \code{data.table}.
 #' @return A chromatogram in the format specified by \code{format_out}

R/read_chemstation_ms.R

@@ -3,7 +3,7 @@
 #' Reads 'Agilent ChemStation MSD Spectral Files' beginning with
 #' \code{x01/x32/x00/x00}.
 #'
-#' @param path Path to \code{.ms} file
+#' @param path Path to Agilent \code{.ms} file.
 #' @param what What stream to get: current options are \code{MS1}, \code{BPC}
 #' and/or \code{TIC}. If a stream is not specified, the function will return all
 #' streams.

R/read_chemstation_uv.R

@@ -6,7 +6,7 @@
 #' \code{131}.
 #'
 #' @importFrom utils head tail
-#' @param path Path to \code{.uv} file.
+#' @param path Path to Agilent \code{.uv} file.
 #' @param format_out Class of output. Either \code{matrix}, \code{data.frame},
 #' or \code{data.table}.
 #' @param data_format Either \code{wide} (default) or \code{long}.

R/read_chromeleon.R

@@ -3,7 +3,7 @@
 #' Reads 'Thermo Fisher Chromeleon™ CDS' ASCII (\code{.txt}) files.
 #'
 #' @importFrom utils tail read.csv
-#' @param path Path to file
+#' @param path Path to Chromeleon ASCII file.
 #' @param format_out Class of output. Either \code{matrix}, \code{data.frame},
 #' or \code{data.table}.
 #' @param data_format Whether to return data in \code{wide} or \code{long} format.

R/read_mzml.R

@@ -7,7 +7,7 @@
 #'
 #' @name read_mzml
 #' @importFrom RaMS grabMSdata
-#' @param path path to file
+#' @param path Path to \code{.mzml} file.
 #' @param format_out Class of output. Only applies if \code{mzR} is selected.
 #' Either \code{matrix}, \code{data.frame}, or \code{data.table}. \code{RaMS}
 #' will return a list of data.tables regardless of what is selected here.

R/read_peaklist.R

@@ -2,7 +2,7 @@
 #'
 #' Reads peak lists from specified folders or vector of paths.
 #'
-#' @param paths paths to files or folders containing files.
+#' @param paths Paths to files or folders containing peaklist files.
 #' @param find_files Logical. Set to \code{TRUE} (default) if you are providing
 #' the function with a folder or vector of folders containing the files.
 #' Otherwise, set to\code{FALSE}.