Suspends the log

Source: R/logr.R

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.

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: C:/Users/dbosa/AppData/Local/Temp/RtmpsjFzDn/log/test.log
#> Working Directory: C:/packages/logr/docs/reference
#> User Name: dbosa
#> R Version: 4.6.1 (2026-06-24 ucrt)
#> Machine: SOCRATES x86-64
#> Operating System: Windows 10 x64 build 26200
#> Base Packages: stats graphics grDevices utils datasets methods base
#> Other Packages: logr_1.4.0 common_1.1.5
#> Log Start Time: 2026-10-15 21:26:41.207149
#> =========================================================================
#> 
#> Before suspend
#> 
#> NOTE: Log Print Time:  2026-10-15 21:26:41.210714
#> NOTE: Elapsed Time: 0.00177311897277832 secs
#> 
#> =========================================================================
#> Log suspended
#> =========================================================================
#> 
#> Autolog: FALSE
#> Log Path: C:/Users/dbosa/AppData/Local/Temp/RtmpsjFzDn/log/test.log
#> Msg Path: C:/Users/dbosa/AppData/Local/Temp/RtmpsjFzDn/log/test.msg
#> Show Notes: TRUE
#> Blank After: TRUE
#> Traceback: TRUE
#> Status: open
#> Tidylog:
#> Log Time: 2026-10-15 21:26:41.210714
#> Start Time: 2026-10-15 21:26:41.208941
#> Suspend Time: 2026-10-15 21:26:41.224532
#> Elapsed Time: 0.0138177871704102
#> 

# Resume log
log_resume(lf)
#> [1] "C:/Users/dbosa/AppData/Local/Temp/RtmpsjFzDn/log/test.log"

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

# Close log
log_close()

# View results
writeLines(readLines(lf))
#> =========================================================================
#> Log Path: C:/Users/dbosa/AppData/Local/Temp/RtmpsjFzDn/log/test.log
#> Working Directory: C:/packages/logr/docs/reference
#> User Name: dbosa
#> R Version: 4.6.1 (2026-06-24 ucrt)
#> Machine: SOCRATES x86-64
#> Operating System: Windows 10 x64 build 26200
#> Base Packages: stats graphics grDevices utils datasets methods base
#> Other Packages: logr_1.4.0 common_1.1.5
#> Log Start Time: 2026-10-15 21:26:41.207149
#> =========================================================================
#> 
#> Before suspend
#> 
#> NOTE: Log Print Time:  2026-10-15 21:26:41.210714
#> NOTE: Elapsed Time: 0.00177311897277832 secs
#> 
#> =========================================================================
#> Log Suspended: 2026-10-15 21:26:41.224532
#> Log Resumed: 2026-10-15 21:26:41.244244
#> Elapsed Time: 0 00:00:00
#> =========================================================================
#> 
#> After suspend
#> 
#> NOTE: Log Print Time:  2026-10-15 21:26:41.259071
#> NOTE: Elapsed Time: 0.00193500518798828 secs
#> 
#> =========================================================================
#> Log End Time: 2026-10-15 21:26:41.261683
#> Log Elapsed Time: 0 00:00:00
#> =========================================================================