summarizeGroupComparisons: Summarize group comparisons

In EMSL-Computing/fticRanalysis: Analysis and visualization tools for FT-MS data

Summarize group comparisons

Description

Summarize a group comparisons object or a ddo of group comparisons objects. This function applies a summary function to the columns of compData$e_data corresponding to each column to calculate a summary column for each group.

Usage

summarizeGroupComparisons(
  compData,
  summary_functions,
  summary_function_params = NULL
)

Arguments

compData	a groupComparison object or a ddo of groupComparison objects, i.e. the output of divideByGroupComparisons.
summary_functions	vector of summary function names to apply to each row of ftmsObj$e_data for each group. Valid summary function names are given by getGroupComparisonSummaryFunctionNames.
summary_function_params	named list of list of other parameters to pass to the summary functions. Names should match values in summary_functions, each value should be a list of name/value parameters, e.g. list(uniqueness_gtest=list(pval_threshold=0.01)).

Details

Currently this function does not allow executing the same summary function multiple times with different parameters.

Value

a comparisonSummary object or a ddo of comparisonSummary objects

EMSL-Computing/fticRanalysis documentation built on Dec. 18, 2024, 9:51 p.m.