A function to send the program/script code to the
currently opened log. The log must be opened first with
log_open. Code will be prefixed with a right arrow (">")
to differentiate it from standard logging lines. The log_code
function may be called from anywhere within the program. Code will
be inserted into the log at the point where it is called. The
log_code function will log the code as it is saved on disk. It
will not capture any unsaved changes in the editor. If the current
program file cannot be found, the function will return FALSE and no
code will be written.
log_code()A TRUE or FALSE value to indicate success or failure of the function.
# Create temp file location
tmp <- file.path(tempdir(), "test.log")
# Open log
lf <- log_open(tmp)
# Write code to the log
log_code()
#> [1] FALSE
# Send message to log
log_print("High Mileage Cars Subset")
#> High Mileage Cars Subset
# Perform operations
hmc <- subset(mtcars, mtcars$mpg > 20)
# Print data to log
log_print(hmc)
#> mpg cyl disp hp drat wt qsec vs am gear carb
#> Mazda RX4 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
#> Mazda RX4 Wag 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
#> Datsun 710 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
#> Hornet 4 Drive 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
#> Merc 240D 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2
#> Merc 230 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2
#> Fiat 128 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1
#> Honda Civic 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2
#> Toyota Corolla 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1
#> Toyota Corona 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1
#> Fiat X1-9 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1
#> Porsche 914-2 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
#> Lotus Europa 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2
#> Volvo 142E 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2
# Close log
log_close()
# View results
writeLines(readLines(lf))
#> =========================================================================
#> Log Path: /tmp/RtmpORwY5l/log/test.log
#> Working Directory: /cluster-data/user-homes/elizabethb/projects/prism-pkgdocs-build/installed-pkgs/priority-3/logr_1.3.9/docs/reference
#> User Name: elizabethb
#> R Version: 4.4.1 (2024-06-14)
#> Machine: uat-uat-a2ai-cloud x86_64
#> Operating System: Linux 6.2.0-1018-aws #18~22.04.1-Ubuntu SMP Wed Jan 10 22:54:16 UTC 2024
#> Base Packages: stats graphics grDevices utils datasets methods base
#> Other Packages: logr_1.3.9 common_1.1.3
#> Log Start Time: 2025-10-14 20:31:04.167546
#> =========================================================================
#>
#> High Mileage Cars Subset
#>
#> NOTE: Log Print Time: 2025-10-14 20:31:04.181958
#> NOTE: Elapsed Time: 0.0139491558074951 secs
#>
#> mpg cyl disp hp drat wt qsec vs am gear carb
#> Mazda RX4 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
#> Mazda RX4 Wag 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
#> Datsun 710 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
#> Hornet 4 Drive 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
#> Merc 240D 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2
#> Merc 230 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2
#> Fiat 128 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1
#> Honda Civic 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2
#> Toyota Corolla 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1
#> Toyota Corona 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1
#> Fiat X1-9 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1
#> Porsche 914-2 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
#> Lotus Europa 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2
#> Volvo 142E 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2
#>
#> NOTE: Data frame has 14 rows and 11 columns.
#>
#> NOTE: Log Print Time: 2025-10-14 20:31:04.187903
#> NOTE: Elapsed Time: 0.00594496726989746 secs
#>
#> =========================================================================
#> Log End Time: 2025-10-14 20:31:04.189093
#> Log Elapsed Time: 0 00:00:00
#> =========================================================================