Sample: Sample

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

Sample

Description

Sample Class

Format

An R6Class generator object

Public fields

id

integer [optional]

name

character [optional]

custom

list( Parameter ) [optional]

species

list( Parameter ) [optional]

tissue

list( Parameter ) [optional]

cell_type

list( Parameter ) [optional]

disease

list( Parameter ) [optional]

description

character [optional]

Methods

Public methods

• Sample$new()

• Sample$toJSON()

• Sample$fromJSON()

• Sample$toJSONString()

• Sample$fromJSONString()

• Sample$toDataFrame()

• Sample$fromDataFrame()

• Sample$clone()

---

Method new()

Create a Sample

Usage

Sample$new(
  id = NULL,
  name = NULL,
  custom = NULL,
  species = NULL,
  tissue = NULL,
  cell_type = NULL,
  disease = NULL,
  description = NULL,
  ...
)

Arguments

id

Sample id.

name

Sample name.

custom

Custom parameters list( Parameter ).

species

Species CV parameters list( Parameter ).

tissue

Tissue CV parameters list( Parameter ).

cell_type

Cell Type CV parameters list( Parameter ).

disease

Disease CV parameters list( Parameter ).

description

Description of the sample.

...

local optional variable arguments

---

Method toJSON()

Serialize to list object suitable for jsonlite

Usage

Sample$toJSON()

---

Method fromJSON()

Deserialize from jsonlite list object

Usage

Sample$fromJSON(SampleJson)

Arguments

SampleJson

list object.

---

Method toJSONString()

Serialize to JSON string.

Usage

Sample$toJSONString()

---

Method fromJSONString()

Deserialize from JSON string

Usage

Sample$fromJSONString(SampleJson)

Arguments

SampleJson

SampleJson string

---

Method toDataFrame()

Serialize to data frame

Usage

Sample$toDataFrame()

---

Method fromDataFrame()

Deserialize from sample data frame

Usage

Sample$fromDataFrame(SampleDataFrame)

Arguments

SampleDataFrame

Sample data frame

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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