Assay: Assay

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

Assay

Description

Assay Class

Format

An R6Class generator object

Public fields

id

integer [optional]

name

character

custom

list( Parameter ) [optional]

external_uri

character [optional]

sample_ref

Sample [optional]

ms_run_ref

list( MsRun )

Methods

Public methods

• Assay$new()

• Assay$toJSON()

• Assay$fromJSON()

• Assay$toJSONString()

• Assay$fromJSONString()

• Assay$toDataFrame()

• Assay$fromDataFrame()

• Assay$clone()

---

Method new()

Create an Assay

Usage

Assay$new(
  name,
  ms_run_ref,
  id = NULL,
  custom = NULL,
  external_uri = NULL,
  sample_ref = NULL,
  ...
)

Arguments

name

Assay name.

ms_run_ref

Reference to MsRuns.

id

Assay id.

custom

Custom parameters.

external_uri

External URI.

sample_ref

Reference to Sample.

...

local optional variable arguments

---

Method toJSON()

Serialize to list object suitable for jsonlite

Usage

Assay$toJSON()

---

Method fromJSON()

Deserialize from jsonlite list object

Usage

Assay$fromJSON(AssayJson)

Arguments

AssayJson

list object.

---

Method toJSONString()

Serialize to JSON string.

Usage

Assay$toJSONString()

---

Method fromJSONString()

Deserialize from JSON string

Usage

Assay$fromJSONString(AssayJson)

Arguments

AssayJson

JSON string

---

Method toDataFrame()

Serialize to data frame

Usage

Assay$toDataFrame()

---

Method fromDataFrame()

Deserialize from assay data frame

Usage

Assay$fromDataFrame(AssayDataFrame)

Arguments

AssayDataFrame

Assay data frame

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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