File: Message-methods.Rd

package info (click to toggle)
r-bioc-bioccheck 1.42.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 632 kB
  • sloc: ansic: 5; makefile: 2
file content (23 lines) | stat: -rw-r--r-- 810 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BiocCheck-class.R
\name{Message-methods}
\alias{Message-methods}
\alias{setMessage,Message-method}
\alias{setCondition,Message-method}
\alias{getCondition,Message-method}
\title{A list of methods for the Message reference class}
\arguments{
\item{condition}{character(1) One of the three conditions handled: \code{error},
\code{warning}, or \code{note}}

\item{\dots}{\code{list()} A nested list with the check name as the top level
layer. Second level lists include any \code{help_text} and \code{messages} that are
part of the check.}
}
\value{
An internal \code{R5} Reference Class to handle messages and their
conditions, e.g., for errors, warnings, or notes.
}
\description{
A list of methods for the Message reference class
}