Comment: Comment

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

Comment

Description

Comment Class

Format

An R6Class generator object

Public fields

prefix

character

msg

character

line_number

integer [optional]

Methods

Public methods

• Comment$new()

• Comment$toJSON()

• Comment$fromJSON()

• Comment$toJSONString()

• Comment$fromJSONString()

• Comment$toDataFrame()

• Comment$fromDataFrame()

• Comment$clone()

---

Method new()

Create a Comment

Usage

Comment$new(prefix, msg, line_number = NULL, ...)

Arguments

prefix

'COM'.

msg

Comment content.

line_number

Line number in the mzTab-M file.

...

local optional variable arguments

---

Method toJSON()

Serialize to list object suitable for jsonlite

Usage

Comment$toJSON()

---

Method fromJSON()

Deserialize from jsonlite list object

Usage

Comment$fromJSON(CommentJson)

Arguments

CommentJson

list object.

---

Method toJSONString()

Serialize to JSON string.

Usage

Comment$toJSONString()

---

Method fromJSONString()

Deserialize from JSON string

Usage

Comment$fromJSONString(CommentJson)

Arguments

CommentJson

JSON string

---

Method toDataFrame()

Serialize to data frame

Usage

Comment$toDataFrame()

---

Method fromDataFrame()

Deserialize from comment data frame

Usage

Comment$fromDataFrame(CommentDataFrame)

Arguments

CommentDataFrame

Comment data frame

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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