structural-accessors: StructuralEnrichment S4 class accessors

In jasenfinch/riches: Strucutral and Functional Enrichment Analyses

StructuralEnrichment S4 class accessors

Description

Accessor methods for the StructuralEnrichment S4 class.

Usage

structuralClassifications(x)

## S4 method for signature 'StructuralEnrichment'
structuralClassifications(x)

## S4 method for signature 'StructuralEnrichment'
explanatoryFeatures(x)

## S4 method for signature 'StructuralEnrichment'
enrichmentResults(x)

Arguments

x	object of S4 class StructuralEnrichment

Value

A tibble containing the accessed information.

Examples

## Perform random forest on the example data 
random_forest <- assigned_data %>% 
  metabolyseR::randomForest(
    cls = 'class'
  )

## Perform functional enrichment analysis
enrichment_results <- structuralEnrichment(
  random_forest,
  structural_classifications
)

## The m/z feature structural classifcations
structuralClassifications(enrichment_results)

## Access the explanatory features used for structural enrichment analysis
explanatoryFeatures(enrichment_results)

## Access the structral enrichment analysis results
enrichmentResults(enrichment_results)

jasenfinch/riches documentation built on April 24, 2023, 9:45 a.m.