MzQCmetadata: The metadata for a run/setQuality

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

The metadata for a run/setQuality

Description

The metadata for a run/setQuality

The metadata for a run/setQuality

Public fields

label

Unique name for the run (for runQuality) or set (for setQuality).

inputFiles

Array/list of MzQCinputFile objects

analysisSoftware

Array/list of MzQCanalysisSoftware objects

cvParameters

(optional) Array of cvParameters objects

Methods

Public methods

• MzQCmetadata$new()

• MzQCmetadata$isValid()

• MzQCmetadata$toJSON()

• MzQCmetadata$fromData()

• MzQCmetadata$clone()

---

Method new()

Constructor

Usage

MzQCmetadata$new(
  label = NA_character_,
  inputFiles = list(),
  analysisSoftware = list(),
  cvParameters = list()
)

Arguments

label

String value for initialization of field label

inputFiles

Optional list value for initialization of field inputFiles

analysisSoftware

Optonal list value for initialization of field analysisSoftware

cvParameters

Optional list value for initialization of field cvParameters

---

Method isValid()

Verifies validity of the object

Usage

MzQCmetadata$isValid(context = "MzQCmetadata")

Arguments

context

Optional string describing location in mzQC structure that is used for more informative warning texts.

---

Method toJSON()

Creates JSON file from this object.

Usage

MzQCmetadata$toJSON(...)

Arguments

...

Optional parameters for jsonlite:::asJSON()

---

Method fromData()

Sets data for this object from plain named lists of R objects

Usage

MzQCmetadata$fromData(data, context = "MzQCmetadata")

Arguments

data

A datastructure of R lists/arrays as obtained by 'jsonlite::fromJSON()'

context

Optional string describing location in mzQC structure that is used for more informative warning texts.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

MzQCmetadata$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

rmzqc documentation built on Aug. 8, 2025, 7:21 p.m.