multiPeak_sum: Formatting/housekeeping function for PeakFunctions output

Description Usage Arguments Value

View source: R/PeakFunctions_multiPeak_sum.R

Description

Formatting/housekeeping function for PeakFunctions output

Usage

1
multiPeak_sum(x, peaks, probDensity, returnComponentPks)

Arguments

x

a vector of x-coordinates from which the corrisponding y-coordinates are calculated

peaks

the peak or peaks to be summed

probDensity

Should the function produce a probability density function 'TRUE' or a gaussian peak 'FALSE' with amplitude k? default is 'TRUE'.

returnComponentPks

Should the function return a single vector containing the sum of each individual peak 'FALSE' or a data.frame containing the input vector 'x', each component peak 'peak_n', and the summed result of the component peaks 'peak_sum'

Value

either a vector or data.frame


pmbrophy/SummitR documentation built on May 20, 2020, 12:36 a.m.