skip_reports: Skip Reporting Function Tests

View source: R/skip_reports.R

skip_reportsR Documentation

Skip Reporting Function Tests

Description

Reporting functions are time-consuming to run; skip_reports() sets an option that allows the user to skip these tests. Component functions should be tested separately.

Usage

skip_reports(skip = NULL)

Arguments

skip

Should the reporting tests be skipped? If getOption(SKIP_REPORTS) is unset during testing, NULL defaults to TRUE.

Details

When skip = NULL, this is used as a skipping function within a test. When a value is supplied, it sets the SKIP_REPORTS option that controls behavior during testing.

Value

Either the previous value of SKIP_REPORTS (if setting the option) or a skip condition


jesse-smith/covidReport documentation built on Aug. 3, 2024, 4:52 p.m.