consonance_suite: create a new suite of consonance tests

Description Usage Arguments Value Examples

View source: R/constructors.R

Description

The constructor always creates an empty suite (without any consonance test). To add tests into the suite, use the + operator together with constructors consonance_assert, consonance_check, or consonance_test.

Usage

1
2
3
4
5
consonance_suite(
  level = c("error", "warning"),
  logging.level = c("WARN", "INFO", "ERROR"),
  log.file = NULL
)

Arguments

level

character, determines when to halt execution

logging.level

character, determines level of verbosity in logs. This argument is over-ridden by setting a non-default logger.

log.file

character, path for a log file, or leave NULL to log to the console The default "log4r" sets up a simple console logger using package log4r. Setting a non-default logger over-rides values set in logging.level.

Value

object of class consonance and consonance_suite

Examples

1
2
3
4
5
6
7
# an empty consonance suite with default settings
suite <- consonance_suite()
suite

# an empty consonance suite thta is verbose (logs more messages)
suite_verbose <- consonance_suite(logging.level="INFO")
suite_verbose

tkonopka/consonance documentation built on Oct. 9, 2020, 2:09 p.m.