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

Description Usage Arguments Value Examples

View source: R/mrbin.R

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

1
mrbin(silent = FALSE, setDefault = FALSE, parameters = 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.

Value

An invisible list containing bins (data after processing), parameters, and factors

Examples

1
2
3
4
5
6
7
# Set parameters in command line.
mrbinExample<-mrbin(silent=TRUE,setDefault=TRUE,parameters=list(dimension="1D",
                binwidth1D=0.05,signal_to_noise1D=100,
                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")),
                Factors=factor(c("Group A","Group A","Group B"))))

mrbin documentation built on April 30, 2021, 1:06 a.m.