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

Export protein group data to Apache Arrow format following QPX pg schema. More...

#include <OpenMS/FORMAT/ProteinGroupArrowExport.h>

Static Public Member Functions

static std::shared_ptr< arrow::Table > exportToArrow (const ConsensusMap &cmap)
 Export protein group data to Apache Arrow Table.
 
static bool exportToParquet (const ConsensusMap &cmap, const String &filename, const ParquetWriteConfig &config=ParquetWriteConfig{})
 Export protein group data to Parquet file.
 

Detailed Description

Export protein group data to Apache Arrow format following QPX pg schema.

This class provides static methods to export protein group quantification data from a ConsensusMap to Apache Arrow Tables and Parquet files. The schema follows the QPX (Quantitative Proteomics Exchange) protein group format.

Protein groups must have quantification annotated via PeptideAndProteinQuant::annotateQuantificationsToProteins() before export.

Experimental classes:
This API is experimental and may change in future versions.

Member Function Documentation

◆ exportToArrow()

static std::shared_ptr< arrow::Table > exportToArrow ( const ConsensusMap cmap)
static

Export protein group data to Apache Arrow Table.

Exports indistinguishable protein groups following the QPX pg schema. One row is emitted per protein group per run file.

Parameters
[in]cmapThe ConsensusMap with annotated protein group quantification
Returns
Shared pointer to Arrow Table, or nullptr on error

◆ exportToParquet()

static bool exportToParquet ( const ConsensusMap cmap,
const String filename,
const ParquetWriteConfig config = ParquetWriteConfig{} 
)
static

Export protein group data to Parquet file.

Parameters
[in]cmapThe ConsensusMap with annotated protein group quantification
[in]filenameOutput file path
[in]configParquet writing options
Returns
true on success, false on error