timechecker (version 1.1.5)

set_step_timechecker: Print elapsed and remaining time in each code block.

Description

set_step_timechecker returns a function that records and prints processing time in each code block.

Usage

set_step_timechecker(
  char_pre = "",
  char_post = "",
  show_timestamp = TRUE,
  verbose = TRUE
)

Value

A function step_timechecker. When placed at the head of each code block, it records and prints the progress and elapsed time. An argument step_name, a string representing the name of the steps, should be provided. Otherwise, the function judges that it is the end of the measurement. An argument print_done can also be used if you do not wish to add message when the process of the step ends.

Arguments

char_pre

String to be added before messages.

char_post

String to be added after messages.

show_timestamp

Logical. Should the time stamp be added to the message?

verbose

Logical. Should the progress be printed in the console?

Details

This function creates a function named step_timechecker which records and prints processing time in code blocks. The created function step_timechecker should be placed at the head of each code block with its name. Also, this function should be placed at the end of all steps with no argument.

See Also

set_loop_timechecker

Examples

# \donttest{
f <- function() {

  tc <- set_step_timechecker()

  tc('Simulation')
  df <- data.frame(x = 1:10, y = 1:10 + rnorm(10))
  Sys.sleep(2)

  tc('Data augumentation')
  df$x2 <- df$x ^ 2
  df$x3 <- df$x ^ 3
  Sys.sleep(3)

  tc('Regression')
  lmres <- lm(y ~ ., df)
  Sys.sleep(4)

  tc()
  coef(lmres)

}
ans <- f()

# when you place set_loop_timechecker in a loop,
# argument char_pre can be used for readability
tcl <- set_loop_timechecker(3, overwrite = FALSE)
for (i in 1:3) {

  tc <- set_step_timechecker(char_pre = '  ')

  tc('Simulation')
  df <- data.frame(x = 1:10, y = 1:10 + rnorm(10))
  Sys.sleep(2)

  tc('Data augumentation')
  df$x2 <- df$x ^ 2
  df$x3 <- df$x ^ 3
  Sys.sleep(3)

  tc('Regression')
  lmres <- lm(y ~ ., df)
  Sys.sleep(4)

  tc()
  tcl()

}

# when you place set_loop_timechecker inside a step in set_step_timechecker,
# argument print_done can be used for readability
f2 <- function() {

  tc <- set_step_timechecker()

  tc('Simulation')
  n <- 10
  df <- data.frame(x = 1:n, y = 1:n + rnorm(10))
  Sys.sleep(2)

  tc('Data augumentation', print_done = FALSE)
  tcl <- set_loop_timechecker(n)
  for (i in seq_len(n)) {
    df$x2[i] <- df$x[i] ^ 2
    df$x3[i] <- df$x[i] ^ 3
    Sys.sleep(0.2)
    tcl(char_pre = '- ')
  }

  tc('Regression')
  lmres <- lm(y ~ ., df)
  Sys.sleep(4)

  tc()
  coef(lmres)

}
ans <- f2()
# }