PerformParamsOptimization: Perform Parameters Optimization

View source: R/Optimize_params.R

PerformParamsOptimizationR Documentation

Perform Parameters Optimization

Description

This function is used to optimize the critical parameters of peak picking and alignment for the following data processing. It utilizes the trimed data and the internal instrument-specific parameters. Parallel computing will be performed. The number of cores user want to use could be specified.

Usage

PerformParamsOptimization(
  mSet,
  param = NULL,
  method = "DoE",
  ncore = 4,
  running.controller = NULL
)

Arguments

mSet

mSet object, usually generated by 'PerformROIExtraction' or 'PerformDataTrimming' here.

param

List, Parameters defined by 'SetPeakParam' function.

method

Character, method of parameters optimization, including "DoE' only. Default is "DoE". Other method is under development.

ncore

Numeric, CPU threads number used to perform the parallel based optimization. If thers is memory issue, please reduce the 'ncore' used here. For default, 2/3 CPU threads of total will be used.

running.controller

The resuming pipeline running controller. Optional. Don't need to define by hand.

Value

will a parameter object can be used for following processing

Author(s)

Zhiqiang Pang zhiqiang.pang@mail.mcgill.ca Jeff Xia jeff.xia@mcgill.ca Mcgill University License: GNU GPL (>= 2)

Examples


DataFiles <- dir(system.file("mzData", package = "mtbls2"), full.names = TRUE,
                 recursive = TRUE)[c(10:12, 14:16)]
# remove the # before running the following command lines
# mSet <- PerformROIExtraction(datapath = DataFiles[c(1:2)],rt.idx = 0.25,
# rmConts = FALSE);#' 
# best_params <- PerformParamsOptimization(mSet, param = SetPeakParam(), ncore = 4);

xia-lab/OptiLCMS documentation built on Nov. 6, 2024, 11:01 a.m.