raise_issue: Warn when assertr checks fail and raise issue on github

In ukgovdatascience/eesectors: Functions to create DCMS Economic Estimates statistics

Description

raise_issue replaces the default function assert_stop which is triggered when an assertion fails. y, relative to x. Optionally allows issues to be posted to a github repository.

Usage

raise_issue(err_str)

Arguments

err_str

Error string arising from an assert::insist_.

Details

The default behaviour of assertr::insist_ of generating an error when assertions are failed could be problematic if the assertion fails for a legitimate reason. This would require an analyst to be able to re-engineer the workings of the function to fix the problem.

It is safer to issue a warning instead, which alerts the user to an issue, but does not prevent the program from running.

If log_issues = TRUE, and owner, repo, and title are not NULL an issue is created in the given github repo with title and additional arguments given by ....

Value

err_str as warning.

ukgovdatascience/eesectors documentation built on Sept. 11, 2020, 12:19 p.m.