Message-class: A lower level Message helper class for BiocCheck

Message-classR Documentation

A lower level Message helper class for BiocCheck

Description

A lower level Message helper class for BiocCheck

Arguments

condition

character(1) One of the three conditions handled: error, warning, or note

...

list() A nested list with the check name as the top level layer. Second level lists include any help_text and messages that are part of the check.

Value

.MessageCondition: An internal R5 Reference Class to handle messages and their conditions, e.g., for errors, warnings, or notes.

Fields

msg

list() A list of character messages usually grown with append with conditions raised by a check

condition

character(1) One of the three conditions handled: error, warning, or note

methods

  • setMessage: Set the message and condition (error, warning, or note) for the check

  • setCondition: Change the condition for the check

  • getCondition: Get the condition from the Message class

See Also

BiocCheck-class BiocPackage-class


Bioconductor/BiocCheck documentation built on June 12, 2025, 6:32 p.m.