Parameter: Parameter

In lifs-tools/rmzTab-m: R Package Client for mzTab-M Reference Implementation and Validation API

Parameter

Description

Parameter Class

Format

An R6Class generator object

Public fields

id

integer [optional]

cv_label

character [optional]

cv_accession

character [optional]

name

character

value

character

Methods

Public methods

• Parameter$new()

• Parameter$toJSON()

• Parameter$fromJSON()

• Parameter$toJSONString()

• Parameter$fromJSONString()

• Parameter$toString()

• Parameter$fromString()

• Parameter$clone()

---

Method new()

Create a Parameter

Usage

Parameter$new(name, value, id = NULL, cv_label = "", cv_accession = "", ...)

Arguments

name

Parameter name.

value

Parameter value.

id

Parameter id.

cv_label

The label of the controlled vocabulary.

cv_accession

The accession number of this Parameter.

...

local optional variable arguments

---

Method toJSON()

Serialize to list object suitable for jsonlite

Usage

Parameter$toJSON()

---

Method fromJSON()

Deserialize from jsonlite list object

Usage

Parameter$fromJSON(ParameterJson)

Arguments

ParameterJson

list object.

---

Method toJSONString()

Serialize to JSON string.

Usage

Parameter$toJSONString()

---

Method fromJSONString()

Deserialize from JSON string

Usage

Parameter$fromJSONString(ParameterJson)

Arguments

ParameterJson

JSON string

---

Method toString()

Serialize to string

Usage

Parameter$toString()

---

Method fromString()

Deserialize from string

Usage

Parameter$fromString(id, ParameterString)

Arguments

id

Optional id of the Parameter.

ParameterString

String representation of the Parameter.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Parameter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

lifs-tools/rmzTab-m documentation built on Jan. 26, 2023, 4:45 p.m.