throw: Throw a Condition

In excerptr: Excerpt Structuring Comments from Your Code File and Set a Table of Contents

Description

Throws a condition of class c("error", "excerptr", "condition").

Usage

throw(message_string, system_call = sys.call(-1), ...)

Arguments

message_string	The message to be thrown.
system_call	The call to be thrown.
...	Arguments to be passed to base::structure.

Details

We use this condition as an error dedicated to excerptr.

Value

The function does never return anything, it stops with a condition of class c("error", "excerptr", "condition").

Examples

tryCatch(excerptr:::throw("Hello error!"), excerptr = function(e) return(e))

excerptr documentation built on Aug. 5, 2021, 1:06 a.m.