StudyVariable: StudyVariable

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

StudyVariable

Description

StudyVariable Class

Format

An R6Class generator object

Public fields

id

integer

name

character

assay_refs

list( Assay ) [optional]

average_function

Parameter [optional]

variation_function

Parameter [optional]

description

character [optional]

factors

list( Parameter ) [optional]

Methods

Public methods

• StudyVariable$new()

• StudyVariable$toJSON()

• StudyVariable$fromJSON()

• StudyVariable$toJSONString()

• StudyVariable$fromJSONString()

• StudyVariable$toDataFrame()

• StudyVariable$fromDataFrame()

• StudyVariable$clone()

---

Method new()

Create a StudyVariable

Usage

StudyVariable$new(
  id,
  name,
  assay_refs = NULL,
  average_function = NULL,
  variation_function = NULL,
  description = NULL,
  factors = NULL,
  ...
)

Arguments

id

StudyVariable id.

name

StudyVariable name.

assay_refs

Reference to list( Assay ).

average_function

The averaging function used to calculate abundance_study_variable, defined by Parameter.

variation_function

The variation function used to calculate abundance_variation_study_variable, defined by Parameter.

description

Description of the StudyVariable.

factors

A list of study variable factors list( Parameter ).

...

local optional variable arguments

---

Method toJSON()

Serialize to list object suitable for jsonlite

Usage

StudyVariable$toJSON()

---

Method fromJSON()

Deserialize from jsonlite list object

Usage

StudyVariable$fromJSON(StudyVariableJson)

Arguments

StudyVariableJson

list object.

---

Method toJSONString()

Serialize to JSON string.

Usage

StudyVariable$toJSONString()

---

Method fromJSONString()

Deserialize from JSON string

Usage

StudyVariable$fromJSONString(StudyVariableJson)

Arguments

StudyVariableJson

JSON string

---

Method toDataFrame()

Serialize to data frame

Usage

StudyVariable$toDataFrame()

---

Method fromDataFrame()

Deserialize from StudyVariable data frame

Usage

StudyVariable$fromDataFrame(StudyVariableDataFrame)

Arguments

StudyVariableDataFrame

StudyVariable data frame

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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