wrap_up: Wrap up file execution.

Description Usage Arguments Value Examples

View source: R/wrap_up.R

Description

Used to interrupt sequential script execution while testing or debugging. Outputs an auditory signal and breaks sequential script execution, identifying the script at which execution was interrupted. Is a Sys.time() object is passed to start_time, messages the elapsed time.

Usage

1
wrap_up(start_time = NULL)

Arguments

start_time

Optional POSIXct object, created by assigning Sys.time() to an object prior to executing wrap_up().

Value

Interrupts sequential script execution with an auditory signal. Logs the elapsed time if start_time is used, outputs the script location.

Examples

1
2
3
4
5
6
7
# halt execution with no timing
try(wrap_up())

# create timing checkpoint
s_time <- Sys.time()
# halt execution with timing
try(wrap_up(s_time))

ptspotter documentation built on May 3, 2021, 9:07 a.m.