Browse Source

Update `@usage` section in documentation

pull/3/head
Philipp Baumann 6 years ago
parent
commit
abf2b0c76b
  1. 5
      R/read-opus-universal.R
  2. 2
      man/read_opus_bin_univ.Rd
  3. 3
      man/read_opus_univ.Rd

5
R/read-opus-universal.R

@ -17,7 +17,7 @@
#' compensation are read with an offset of \code{-4} bites from Bruker OPUS
#' files. Default is \code{FALSE}.
#' @usage read_opus_bin_univ(file_path, extract = c("spc"),
#' print_progress = TRUE)
#' print_progress = TRUE, atm_comp_minus4offset = FALSE)
#' @export
# Importing functions `%do%` and foreach::`%dopar%` does not work, see
# http://stackoverflow.com/questions/30216613/how-to-use-dopar-when-only-import-foreach-in-description-of-a-package
@ -636,7 +636,8 @@ read_opus_bin_univ <- function(file_path, extract = c("spc"),
#' @param atm_comp_minus4offset Logical whether spectra after atmospheric
#' compensation are read with an offset of \code{-4} bites from Bruker OPUS
#' files. Default is \code{FALSE}.
#' @usage read_opus_univ(fnames, extract = c("spc"), parallel = FALSE)
#' @usage read_opus_univ(fnames, extract = c("spc"), parallel = FALSE,
#' atm_comp_minus4offset = FALSE)
#' @return out List spectra and metadata (parameters) extracted from
#' Bruker OPUS spectrometer files. List names are the names of the OPUS
#' files whose spectral data were extracted.

2
man/read_opus_bin_univ.Rd

@ -5,7 +5,7 @@
\title{Read a Bruker OPUS spectrum binary file}
\usage{
read_opus_bin_univ(file_path, extract = c("spc"),
print_progress = TRUE)
print_progress = TRUE, atm_comp_minus4offset = FALSE)
}
\arguments{
\item{file_path}{Character vector with path to file}

3
man/read_opus_univ.Rd

@ -4,7 +4,8 @@
\alias{read_opus_univ}
\title{Read a list of Bruker OPUS spectrum binary files.}
\usage{
read_opus_univ(fnames, extract = c("spc"), parallel = FALSE)
read_opus_univ(fnames, extract = c("spc"), parallel = FALSE,
atm_comp_minus4offset = FALSE)
}
\arguments{
\item{fnames}{List of character vectors containing full path names of spectra}

Loading…
Cancel
Save