getTotalFoundInCategories: Utility method to return metabolite counts found in compound...

View source: R/rampQueryHelper.R

getTotalFoundInCategoriesR Documentation

Utility method to return metabolite counts found in compound class categories based on an input data compound class data object from the chemicalClassSurvey function The returned counts for each class category are for both the metabolite id query list and for the larger full or user-defined population of metabolite ids. This method is used in the exported chemicalClassEnrichment function

Description

Utility method to return metabolite counts found in compound class categories based on an input data compound class data object from the chemicalClassSurvey function The returned counts for each class category are for both the metabolite id query list and for the larger full or user-defined population of metabolite ids. This method is used in the exported chemicalClassEnrichment function

Usage

getTotalFoundInCategories(classData)

Arguments

classData

Data object returned from a call to chemicalClassSurvey This input contains lists of chemical classes that pertain to a query list of metabolites and pertaining to metabolites in a larger metabolite population.

Value

a list object with two keys, 'mets' and 'pop' that each has a table of metabolite or population chemical classes and metabolite counts per class. This supports the chemicalClassEnrichment function.


ncats/RaMP-DB documentation built on Sept. 26, 2022, 4:37 a.m.