MzQCFile

class pyopenms.MzQCFile

Bases: object

Cython implementation of _MzQCFile

Original C++ documentation is available here

File adapter for mzQC files used to load and store mzQC files

This class collects the data for the mzQC File

__init__(self) → None

Methods

__init__(self)
store(self, input_file, output_file, exp, ...)	Stores QC data in mzQC file with JSON format

store(self, input_file: bytes | str | String, output_file: bytes | str | String, exp: MSExperiment, contact_name: bytes | str | String, contact_address: bytes | str | String, description: bytes | str | String, label: bytes | str | String, feature_map: FeatureMap, prot_ids: List[ProteinIdentification], pep_ids: List[PeptideIdentification]) → None

Stores QC data in mzQC file with JSON format

Parameters:

• input_file – MzML input file name

• output_file – MzQC output file name

• exp – MSExperiment to extract QC data from, prior sortSpectra() and updateRanges() required

• contact_name – Name of the person creating the mzQC file

• contact_address – Contact address (mail/e-mail or phone) of the person creating the mzQC file

• description – Description and comments about the mzQC file contents

• label – Qnique and informative label for the run

• feature_map – FeatureMap from feature file (featureXML)

• prot_ids – Protein identifications from ID file (idXML)

• pep_ids – Protein identifications from ID file (idXML)