OpenMS
Loading...
Searching...
No Matches
GNPSMetaValueFile Class Reference

Writer for the meta-value (.TSV) table consumed by GNPS Feature-Based Molecular Networking. More...

#include <OpenMS/FORMAT/GNPSMetaValueFile.h>

Static Public Member Functions

static void store (const ConsensusMap &consensus_map, const std::string &output_file)
 Write the FBMN meta-value TSV seed.
 

Detailed Description

Writer for the meta-value (.TSV) table consumed by GNPS Feature-Based Molecular Networking.

GNPS FBMN can pick up per-sample metadata so the web platform can group / colour network nodes by sample attribute. The writer here produces the minimal seed of such a table: one row per mzML file used to build the input ConsensusMap, populated with that file's basename and a sequential MAP<i> identifier. Users typically extend the file with additional attribute columns before uploading to GNPS (see https://ccms-ucsd.github.io/GNPSDocumentation/metadata/).

The file is optional for FBMN — supplying it lets users group/colour by attribute on the GNPS side. Produced by the GNPSExport tool.

Member Function Documentation

◆ store()

static void store ( const ConsensusMap consensus_map,
const std::string &  output_file 
)
static

Write the FBMN meta-value TSV seed.

Pulls the primary mzML run paths from consensus_map via ConsensusMap::getPrimaryMSRunPath and emits one row per path. The file starts with a header row "\\tfilename\\tATTRIBUTE_MAPID" (the first column header is empty); each data row is "&lt;index&gt;\\t&lt;basename(path)&gt;\\tMAP&lt;index&gt;" with index running from 0.

Parameters
[in]consensus_mapConsensus map whose primary MS-run paths provide the file list.
[in]output_fileDestination path for the TSV file (overwritten if it exists).

Referenced by TOPPGNPSExport::main_().