R/subtractPeaks.R

In kbseah/mass2adduct: Mass Spectrometry Imaging Molecular Adduct Finder

#' Remove peaks within specified mass accuracy
#'
#' Remove peaks, e.g. known contaminants, from an msimat object or plain
#' peaklist. The peaks are specified by their m/z values, and peak intensities
#' are not taken into account. Mass accuracies (expressed as ppm values) for
#' both the msimat dataset and the removal peaklist must be specified, and will
#' be used to determine the margin of error for excluding a given peak.
#'
#' @param input numeric; msimat object or vector containing peaks to be removed
#' @param vec numeric; List of peaks to be removed from d
#' @param ppm1 numeric; Mass accuracy for peaklist v1, in ppm
#' @param ppm2 numeric; Mass accuracy for peaklist v2, in ppm
#' @param ... other parameters
#'
#' @return msimat object or numeric
#'
#' @seealso \code{\link{subtractPeaks.msimat}}
#' @seealso \code{\link{subtractPeaks.numeric}}
#' @seealso \code{\link{filterPeaks}}
#' @export

subtractPeaks <- function(input,
                          vec,
                          ppm1,
                          ppm2,
                          ...) UseMethod("subtractPeaks")