binneRlyse: Perform spectral binning

In jasenfinch/binneR: Spectral Processing for High Resolution Flow Infusion Mass Spectrometry

Perform spectral binning

Description

perform spectral binning.

Usage

binneRlyse(files, info, parameters = binParameters(), verbose = TRUE)

Arguments

files	character vector of file paths to use for spectral binning
info	tibble containing sample information
parameters	object of class BinParameters containing parameters for spectral binning
verbose	show console output

Details

Parallel processing is managed by the future package. This can be specified using the plan() function. See the example below and ?future::plan for details on how this can be specified.

By default, spectral binning is performed at the recommended 2 decimal places. This can be altered by setting either the global option binner_dp or the environment variable BINNER_DP.

Value

S4 object of class Binalysis.

See Also

Binalysis-class, binParameters, sampleInfo, binnedData, accurateData

Examples

## Not run: 
files <- metaboData::filePaths('FIE-HRMS','BdistachyonTechnical')

info <- metaboData::runinfo('FIE-HRMS','BdistachyonTechnical')

parameters <- detectParameters(files)
cls(parameters) <- 'class'

## Optionally declare parallel processing backend
# plan(future::multisession,workers = 2)

analysis <- binneRlyse(files, 
                       info, 
                       parameters = parameters)

## End(Not run)

jasenfinch/binneR documentation built on Aug. 21, 2023, 9:22 a.m.