readMSDial: Read MS-DIAL Output File into a QFeatures Object

View source: R/readMSDial.R

readMSDialR Documentation

Read MS-DIAL Output File into a QFeatures Object

Description

This function reads the output file from MS-DIAL and converts it into a QFeatures object.

Usage

readMSDial(file, version)

Arguments

file

A string with the path to the MS-DIAL output file.

version

A character string specifying the version of MS-DIAL used to generate the file. This parameter is currently not used.

Value

A QFeatures object containing:

  • An assay named "exampleAssay" with the metabolite counts.

  • Row data (feature metadata) extracted from the input file.

  • Column data (sample metadata) extracted from the input file.

See Also

QFeatures for more information on the QFeatures class. SummarizedExperiment for details on the underlying data structure.

Examples

## Not run: 
# Assuming you have an MS-DIAL output file named
 "Metabolite_profile_showcase.txt" in a "data" directory:
qf <- readMSDial("data/Metabolite_profile_showcase.txt")

# Examine the structure of the resulting QFeatures object
qf

# Access the assay data
assay(qf[["exampleAssay"]])

# Access the row data (feature metadata)
rowData(qf[["exampleAssay"]])

# Access the column data (sample metadata)
colData(qf)

## End(Not run)


ipb-halle/MetFamily documentation built on April 5, 2025, 5:05 p.m.