make_kpb_output_decisions: Progress Output Location

In rmflight/knitrProgressBar: Provides Progress Bars in 'knitr'

Description

Provides functionality to decide how the progress should be written, if at all.

Usage

make_kpb_output_decisions()

Details

This function makes decisions about how the progress bar should be displayed based on whether:

1. The code is being run in an interactive session or not

2. The code is part of a knitr evaluation using knit() or rmarkdown::render()

3. Options set by the user. These options include:

   1. kpb.suppress_noninteractive: a logical value. Whether to suppress output when being run non-interactively.

   2. kpb.use_logfile: logical, should a log-file be used for output?

   3. kpb.log_file: character string defining the log-file to use. kpb.use_logfile must be TRUE.

   4. kpb.log_pattern: character string providing a pattern to use, will be combined with the chunk label to create a log-file for each knitr chunk. kpb.use_logfile must be TRUE.

Based on these, it will either return a newly opened connection, either via stderr(), stdout(), or a file connection via file("logfile.log", open = "w"). Note that for files this will overwrite a previously existing file, and the contents will be lost.

Value

a write-able connection or NULL

Examples

## Not run: 
# suppress output when not interactive
options(kpb.suppress_noninteractive = TRUE)

# use a log-file, will default to kpb_output.txt
options(kpb.use_logfile = TRUE)

# use a specific log-file
options(kpb.use_logfile = TRUE)
options(kpb.log_file = "progress.txt")

# use a log-file based on chunk names
options(kpb.use_logfile = TRUE)
options(kpb.log_pattern = "pb_out_")
# for a document with a chunk labeled: "longcalc", this will generate "pb_out_longcalc.log"

## End(Not run)

rmflight/knitrProgressBar documentation built on May 24, 2019, 8:45 p.m.