API Documentation

The spectra-cluster-py project provides a set of APIs that support the development of own scripts to work with MS/MS clustering results in the .clustering format.

Core

The core of the API is made up of a set of common objects that represent the clustering results and the Clustering Parser used to parse the .clustering files.

Analysers

The functionality of all end-user tools is represented through the analysers. Each analyser implements the AbstractAnalyser class.

Exporter

The exporter classes implement the AbstractAnalyser class but convert the clusters’ consensus spectra into different file formats.

API Class List

• Objects
• Clustering Parser
  • Usage
  • Class Definition
• Abstract Analyser
  • Usage
  • Class Definition
• IdTransferer
  • Class Definition
• ClusterAsFeatures
  • Class Definition
• Exporter Package
  • mgf_exporter