protocolcheck: The 'protocolcheck' R6 class

In inbo/protocolshelper: Helper Functions to Manage Protocols

The protocolcheck R6 class

Description

A class that collects and shows all check results.

Public fields

protocol_code

Character string giving the protocol code.

path

Character string giving the relative path to the protocol.

error

Character vector containing all errors found in the protocol

Methods

Public methods

• protocolcheck$new()

• protocolcheck$add_error()

• protocolcheck$check()

• protocolcheck$clone()

---

Method new()

Create a new Protocolcheck object.

Usage

protocolcheck$new(protocol_code)

Arguments

protocol_code

Character string giving the protocol code.

Returns

A new Protocolcheck object

---

Method add_error()

Add a new error to the Protocolcheck object.

Usage

protocolcheck$add_error(msg)

Arguments

msg

Error message to be added.

---

Method check()

Give error report from Protocolcheck object.

Usage

protocolcheck$check(fail)

Arguments

fail

Should an error be dropped if the report contains errors?

Returns

An error report (and if desired an error is dropped).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

protocolcheck$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other check: check_all(), check_all_author_info(), check_frontmatter(), check_structure(), validate_orcid()

inbo/protocolshelper documentation built on Sept. 6, 2024, 9:15 p.m.