MzQCanalysisSoftware: Details of the software used to create the QC metrics

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

Details of the software used to create the QC metrics

Description

Details of the software used to create the QC metrics

Details of the software used to create the QC metrics

Public fields

accession

Accession number identifying the term within its controlled vocabulary.

name

Name of the controlled vocabulary term describing the software tool.

version

Version number of the software tool.

uri

Publicly accessible URI of the software tool or documentation.

description

(optional) Definition of the controlled vocabulary term.

value

(optional) Name of the software tool.

Methods

Public methods

• MzQCanalysisSoftware$new()

• MzQCanalysisSoftware$isValid()

• MzQCanalysisSoftware$toJSON()

• MzQCanalysisSoftware$fromData()

• MzQCanalysisSoftware$clone()

---

Method new()

Constructor

Usage

MzQCanalysisSoftware$new(
  accession = NA_character_,
  name = NA_character_,
  version = NA_character_,
  uri = NA_character_,
  description = NA_character_,
  value = NA_character_
)

Arguments

accession

String value for initialization of field accession

name

String value for initialization of field name

version

String value for initialization of field version

uri

Optional string value for initialization of field uri

description

Optional string value for initialization of field description

value

Optional string value for initialization of field value

---

Method isValid()

Verifies validity of the object

Usage

MzQCanalysisSoftware$isValid(context = "MzQCanalysisSoftware")

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

MzQCanalysisSoftware$toJSON(...)

Arguments

...

Optional parameters for jsonlite:::asJSON()

---

Method fromData()

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

Usage

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

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

MzQCanalysisSoftware$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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