12.4 Truncate text output

When the text output from a code chunk is lengthy, you may want to only show the first few lines. For example, when printing a data frame of a few thousand rows, it may not be helpful to show the full data, and the first few lines may be enough. Below we redefine the output hook so that we can control the maximum number of lines via a custom chunk option out.lines:

  1. # save the built-in output hook
  2. hook_output <- knitr::knit_hooks$get("output")
  4. # set a new output hook to truncate text output
  5. knitr::knit_hooks$set(output = function(x, options) {
  6.   if (!is.null(n <- options$out.lines)) {
  7.     x <- xfun::split_lines(x)
  8.     if (length(x) > n) {
  9.       # truncate the output
  10.       x <- c(head(x, n), "....\n")
  11.     }
  12.     x <- paste(x, collapse = "\n")
  13.   }
  14.   hook_output(x, options)
  15. })

The basic idea of the above hook function is that if the number of lines of the text output is greater than the threshold set in the chunk option out.lines (stored in the variable n in the function body), we only keep the first n lines and add an ellipsis (....) to indicate the output is truncated.

Now we can test the new output hook by setting the chunk option out.lines = 4 on the chunk below:

  1. print(cars)
  1. ##    speed dist
  2. ## 1      4    2
  3. ## 2      4   10
  4. ## 3      7    4
  5. ....

And you see four lines of output as expected. Since we have stored the original output hook in hook_output, we can restore it by calling the set() method again:

  1. knitr::knit_hooks$set(output = hook_output)

As an exercise for readers, you may try to truncate the output in a different way: given the chunk option out.lines to determine the maximum number of lines, can you truncate the output in the middle instead of the end? For example, if out.lines = 10, you extract the first and last five lines, and add .... in the middle like this:

  1. ##    speed dist
  2. ## 1      4    2
  3. ## 2      4   10
  4. ## 3      7    4
  5. ## 4      7   22
  6. ....
  7. ## 46    24   70
  8. ## 47    24   92
  9. ## 48    24   93
  10. ## 49    24  120
  11. ## 50    25   85

Please note that the last line in the output (i.e., the argument x of the hook function) might be an empty line, so you may need something like c(head(x, n/2), '....', tail(x, n/2 + 1)) (+ 1 to take the last empty line into account).