check_pass: Create custom conditions for reporting

In Sage-Bionetworks/stopadforms: STOP-AD Forms

Create custom conditions for reporting

Description

These functions create custom condition objects with subclasses "check_pass", "check_warn", and "check_fail" (inheriting from "message", "warning", or "error", respectively).

Usage

check_pass(msg, behavior, data = NULL)

check_warn(msg, behavior, data = NULL)

check_fail(msg, behavior, data = NULL)

Arguments

msg	Message to report
behavior	Statement of the correct behavior (i.e. what the higher level function was checking for)
data	Data to return (e.g. invalid values that need attention)

Value

An S3 object of class "check_pass", "check_warn", or "check_fail"

Examples

check_pass(msg = "Success!", behavior = "Files should be complete")
check_warn(
  msg = "Warning, some data is missing",
  behavior = "Files should be complete",
  data = c("specimenID", "assay") # columns with missing data
)
check_fail(
  msg = "Error, some required data is missing",
  behavior = "Files should be complete",
  data = c("specimenID", "assay") # columns with missing data
)

Sage-Bionetworks/stopadforms documentation built on Aug. 31, 2024, 11:53 p.m.