File definition

Source: R/utilities.R

Define the regex pattern to the files to highlight.

It finds plots given a vector of regex paths/

Add highlighted files (mainly tables and Graphics).

highlight_f_def(
  x,
  title_pattern = c("pdf$"),
  path = "no_path/found",
  lock = FALSE
)

report_files(confs, name, path = "/no/path", lock = FALSE, ...)

highlight_f(
  hfiles,
  path,
  hlevel = "###",
  close_tabset = FALSE,
  address = "file://",
  verbose = FALSE
)

Arguments

x

Step config or just the path to the step's output.
title_pattern

File regex, Default: c("pdf$")
path

Step's output path.
lock

Whethe to look for 'locking plots in clustering', Default: FALSE.
confs

List of config steps.
name

Name in the 'confs' list.
...

More parameters for 'highlight_f'.
hfiles

regex to find the file.
hlevel

Header level, Default: '###'.
close_tabset

In case you need something to show right after the last tab, Default: FALSE.
address

Server address, Default: 'file://'.
verbose

Show progress, Default: FALSE.

Value

Config list with the highlighting regex patterns.

All lines created are showed with 'cat'.

Adds the file to the report.

Details

This might not work without r, result='asis'.

Tries to find the file using the regex.

See also

case fread kable

Examples

if (FALSE) {
 if(interactive()) highlight_f_def("~/Documents/liai/literature")
}
if (FALSE) {
 if(interactive()){
   report_files(
     confs = list(demx = list("/path/2/output", hfiles = 'pdf$')),
     name = "demx", path = "/path/2/output"
   )
 }
}
if (FALSE) {
 if(interactive()) highlight_f("pdf", "~/Documents/liai/literature")
}