mrbin: A function setting the parameters and performing binning and...

View source: R/mrbin.R

mrbinR Documentation

A function setting the parameters and performing binning and data processing

Description

This function guides the user through the set-up of parameters, starts binning and performs the chosen data processing steps. If a list of parameters is provided and silent is set to TRUE, no user input is requested and binning and data processing are performed silently.

Usage

mrbin(silent = FALSE, setDefault = FALSE, parameters = NULL, metadata = NULL)

Arguments

silent

If TRUE, the user will be asked no questions and binning and data analysis will run according to the current parameters. Defaults to FALSE.

setDefault

If TRUE, all current parameters will be replaced by the default parameters (before loading any provided parameters sets). Defaults to FALSE.

parameters

Optional: A list of parameters, see examples for details. If omitted, the user will be asked through a series of question to set the parameters.

metadata

Optional: A list of metadata. If omitted, the user can add metadata after generating bin data.

Value

An invisible object of type "mrbin" containing bins (data after processing), parameters, and factors

Examples

# Set parameters in command line.
mrbinResults<-mrbin(silent=TRUE,setDefault=TRUE,parameters=list(
                dimension="1D",binwidth1D=0.01,tryParallel=FALSE,
                signal_to_noise1D=25,noiseThreshold=0.75,
                NMRfolders=c(
                system.file("extdata/1/10/pdata/10",package="mrbin"),
                system.file("extdata/2/10/pdata/10",package="mrbin"),
                system.file("extdata/3/10/pdata/10",package="mrbin"))
                ))

mrbin documentation built on Jan. 23, 2023, 5:41 p.m.