Skip to contents

The log_suspend function function suspends printing to the log, but does not close it. The function will not print the log footer. To reopen the log, call log_resume.

Usage

log_suspend()

Value

None

See also

log_resume to continue logging.

Examples

library(logr)

# Create temp file location
tmp <- file.path(tempdir(), "test.log")

# Open log
lf <- log_open(tmp)

# Send message to log
log_print("Before suspend")
#> Before suspend 

# Suspend log
log_suspend()
#> Log suspended

# View suspended log
writeLines(readLines(lf))
#> ========================================================================= 
#> Log Path: /tmp/RtmpI4bEze/log/test.log 
#> Working Directory: /tmp/.tmpGy5KKX/docs/logr/1.4.1/src/docs/reference 
#> User Name: runner 
#> R Version: 4.6.2 (2026-10-29) 
#> Machine: runnervm48cm3 x86_64 
#> Operating System: Linux 7.0.0-1017-azure #17~24.04.1-Ubuntu SMP PREEMPT Thu Sep 24 18:46:57 UTC 2026 
#> Base Packages: stats graphics grDevices utils datasets methods base 
#> Other Packages: logr_1.4.1 common_1.1.5 
#> Log Start Time: 2026-10-29 23:27:02.230293 
#> ========================================================================= 
#> 
#> Before suspend 
#> 
#> NOTE: Log Print Time:  2026-10-29 23:27:02.231739 
#> NOTE: Elapsed Time: 0.00107192993164062 secs 
#> 
#> ========================================================================= 
#> Log suspended 
#> ========================================================================= 
#> 
#> Autolog: FALSE 
#> Log Path: /tmp/RtmpI4bEze/log/test.log 
#> Msg Path: /tmp/RtmpI4bEze/log/test.msg 
#> Show Notes: TRUE 
#> Blank After: TRUE 
#> Traceback: TRUE 
#> Status: open 
#> Tidylog: 
#> Log Time: 2026-10-29 23:27:02.231739 
#> Start Time: 2026-10-29 23:27:02.230667 
#> Suspend Time: 2026-10-29 23:27:02.235472 
#> Elapsed Time: 0.00373291969299316 
#> 

# Resume log
log_resume(lf)
#> [1] "/tmp/RtmpI4bEze/log/test.log"

# Print data to log
log_print("After suspend")
#> After suspend 

# Close log
log_close()

# View results
writeLines(readLines(lf))
#> ========================================================================= 
#> Log Path: /tmp/RtmpI4bEze/log/test.log 
#> Working Directory: /tmp/.tmpGy5KKX/docs/logr/1.4.1/src/docs/reference 
#> User Name: runner 
#> R Version: 4.6.2 (2026-10-29) 
#> Machine: runnervm48cm3 x86_64 
#> Operating System: Linux 7.0.0-1017-azure #17~24.04.1-Ubuntu SMP PREEMPT Thu Sep 24 18:46:57 UTC 2026 
#> Base Packages: stats graphics grDevices utils datasets methods base 
#> Other Packages: logr_1.4.1 common_1.1.5 
#> Log Start Time: 2026-10-29 23:27:02.230293 
#> ========================================================================= 
#> 
#> Before suspend 
#> 
#> NOTE: Log Print Time:  2026-10-29 23:27:02.231739 
#> NOTE: Elapsed Time: 0.00107192993164062 secs 
#> 
#> =========================================================================
#> Log Suspended: 2026-10-29 23:27:02.235472
#> Log Resumed: 2026-10-29 23:27:02.239241
#> Elapsed Time: 0 00:00:00
#> =========================================================================
#> 
#> After suspend 
#> 
#> NOTE: Log Print Time:  2026-10-29 23:27:02.241093 
#> NOTE: Elapsed Time: 0.00130701065063477 secs 
#> 
#> ========================================================================= 
#> Log End Time: 2026-10-29 23:27:02.242434 
#> Log Elapsed Time: 0 00:00:00 
#> =========================================================================