ValidationMessage: ValidationMessage

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

ValidationMessage

Description

ValidationMessage Class

Format

An R6Class generator object

Public fields

code

character

category

character

message_type

character [optional]

message

character

line_number

integer [optional]

Methods

Public methods

• ValidationMessage$new()

• ValidationMessage$toJSON()

• ValidationMessage$fromJSON()

• ValidationMessage$toJSONString()

• ValidationMessage$fromJSONString()

• ValidationMessage$clone()

---

Method new()

Create a new ValidationMessage object.

Usage

ValidationMessage$new(
  code,
  category,
  message,
  message_type = "info",
  line_number = NULL,
  ...
)

Arguments

code

The message code.

category

The message category.

message

The message content.

message_type

The message type.

line_number

The line number in the mzTab-M file to which this message refers to.

...

local optional variable arguments

---

Method toJSON()

Serialize to list object suitable for jsonlite

Usage

ValidationMessage$toJSON()

---

Method fromJSON()

Deserialize from jsonlite list object

Usage

ValidationMessage$fromJSON(ValidationMessageJson)

Arguments

ValidationMessageJson

list object.

---

Method toJSONString()

Serialize to JSON string.

Usage

ValidationMessage$toJSONString()

---

Method fromJSONString()

Deserialize from JSON string

Usage

ValidationMessage$fromJSONString(ValidationMessageJson)

Arguments

ValidationMessageJson

JSON string

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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