rmzqc0.7.0 package

Creation, Reading and Validation of 'mzqc' Files

check_field_exists

Check if a field exists in data and warn if it doesn't, then return th...

check_type

Checks the value's class type, which should match at least of the type...

checkUnexpectedFields

Check for unexpected fields in data and warn if any are found

CV_

CV_

filenameToCV

For a given filename (e.g. "test.mzML"), check the suffix and translat...

fromDatatoMzQC

Allow conversion of plain named lists of R objects (from jSON) to mzQC...

fromDatatoMzQCobj

Allow conversion of a plain R object (obtained from jSON) to an mzQC o...

getCVDictionary

Fetch and parse the 'psi-ms.obo' and some metadata from the usual sour...

getCVInfo

Returns an MzQCcontrolledVocabulary for the currently used CV (see `...

getCVSingleton

Returns the CV singleton. See CV_.

getCVTemplate

Fills a MzQCcvParameter object with id(accession) and name. The value ...

getDefaultCV

Returns an MzQCcontrolledVocabulary for the currently used CV (see `ge...

getLatest_PSICV_URL

Get the latest PSI-MS CV release URL

getLocal_CV_Version

Obtains the 'data-version' from a local (i.e. non-url) PSI-MS-CV

getOptionalValue

Get an optional value from data, using a default if not present

getQualityMetricTemplate

Fills a MzQCqualityMetric object with id(accession) and name. The valu...

getSyntaxValidator

Get a syntax validator for mzQC

hasFileSuffix

Checks if filepath ends in suffix (ignoring lower/upper case differenc...

isUndefined

Tell if a variable's value is undefined (NA or NULL); If yes, and it i...

isValidMzQC

Checks validity (= completeness) of mzQC objects - or lists (JSON arra...

localFileToURI

Convert a local filename, e.g. "./myData/test.mzML" to a proper URI (e...

MzQCanalysisSoftware

Details of the software used to create the QC metrics

MzQCbaseQuality_getMetric

Extract a certain metric from a runQuality's list of MzQCqualityMetric

MzQCbaseQuality

Base class of runQuality/setQuality

MzQCcontrolledVocabulary

A controlled vocabulary document, usually pointing to an .obo file

MzQCcvParameter

A controlled vocabulary parameter, as detailed in the OBO file

MzQCDateTime

An mzQC-formatted date+time in ISO8601 format, as required by the mzQC...

MzQCinputFile

An inputfile within metadata for a run/setQuality

MzQCmetadata

The metadata for a run/setQuality

MzQCmzQC

Root element of an mzQC document

MzQCqualityMetric

The central class to store QC information

MzQCrunQuality

A runQuality object. Use to report metrics for individual runs which a...

MzQCsetQuality

A setQuality object. Use it for metrics which are specific to sets, i....

NULL_to_charNA

Converts a NULL to NA_character_; or returns the argument unchanged ot...

NULL_to_NA

Converts a NULL to NA; or returns the argument unchanged otherwise

parseOBO

Get the information of each CV term from an obo file.

readMZQC

Read a JSON file in mzQC format into an MzQCmzQC root object

readMZQCFromJSON

Read a JSON object in mzQC format into an MzQCmzQC root object

removeFileSuffix

Removes the last suffix (including the last dot) from a filename. If n...

removeIfExists

Remove a file, if it exists (useful for temporary files which may or m...

rmzqc-package

rmzqc: Creation, Reading and Validation of 'mzqc' Files

toAnalysisSoftware

From an ID, e.g. "MS:1003162" (for PTX-QC), and some additional inform...

toQCMetric

Create an 'MzQCqualityMetric' object from two inputs (id and value).

validateFromFile

Syntactically validates an mzQC document which is present as a file.

validateFromObj

Syntactically validates an mzQC document which is already in memory as...

validateFromString

Syntactically validates an mzQC document which is already in memory as...

writeMZQC

Writes a full mzQC object to disk.

Reads, writes and validates 'mzQC' files. The 'mzQC' format is a standardized file format for the exchange, transmission, and archiving of quality metrics derived from biological mass spectrometry data, as defined by the HUPO-PSI (Human Proteome Organisation - Proteomics Standards Initiative) Quality Control working group. See <https://hupo-psi.github.io/mzQC/> for details.

  • Maintainer: Chris Bielow
  • License: MIT + file LICENSE
  • Last published: 2025-07-16