Instrument: Instrument

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

Instrument

Description

Instrument Class

Format

An R6Class generator object

Public fields

id

integer [optional]

name

Parameter [optional]

source

Parameter [optional]

analyzer

list( Parameter ) [optional]

detector

Parameter [optional]

Methods

Public methods

• Instrument$new()

• Instrument$toJSON()

• Instrument$fromJSON()

• Instrument$toJSONString()

• Instrument$fromJSONString()

• Instrument$toDataFrame()

• Instrument$fromDataFrame()

• Instrument$clone()

---

Method new()

Create an Instrument

Usage

Instrument$new(
  id = NULL,
  name = NULL,
  source = NULL,
  analyzer = NULL,
  detector = NULL,
  ...
)

Arguments

id

Instrument id.

name

Instrument name Parameter.

source

Instrument source Parameter.

analyzer

Instrument analyzer list( Parameter )s.

detector

Instrument detector Parameter.

...

local optional variable arguments

---

Method toJSON()

Serialize to list object suitable for jsonlite

Usage

Instrument$toJSON()

---

Method fromJSON()

Deserialize from jsonlite list object

Usage

Instrument$fromJSON(InstrumentJson)

Arguments

InstrumentJson

list object.

---

Method toJSONString()

Serialize to JSON string.

Usage

Instrument$toJSONString()

---

Method fromJSONString()

Deserialize from JSON string

Usage

Instrument$fromJSONString(InstrumentJson)

Arguments

InstrumentJson

JSON string

---

Method toDataFrame()

Serialize to data frame

Usage

Instrument$toDataFrame()

---

Method fromDataFrame()

Deserialize from instrument data frame

Usage

Instrument$fromDataFrame(InstrumentDataFrame)

Arguments

InstrumentDataFrame

Instrument data frame

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Instrument$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.