feedback_to_console: Print to the console. Internal use.

Description Usage Arguments Value

View source: R/feedback.R

Description

Helper function for the feedback function to print stuff to the console. Everything will also be added to the logfile. Internal use. Use the robust 'feedback' function instead.

Usage

1
2
3
4
5
6
7
8
9
feedback_to_console(
  print_this,
  type,
  findme,
  prefix,
  suffix,
  logjs,
  logfile_dir
)

Arguments

print_this

(Optional, String, default: "")

type

(Optional, String, default: "Info") E.g. "Warning", "Error. Default: "Info"

findme

(Optional, String, default: "") Recommended with length 10. String to find the message in the code. E.g. 10-digit random hex from (<https://www.browserling.com/tools/random-hex>) or (<https://onlinerandomtools.com/generate-random-hexadecimal-numbers>)

prefix

Prefix (Optional, String, default: "") This is useful if print_this is an array/list. Each entry will then be new row with this prefix.

suffix

Suffix (Optional, String, default: "") Same like prefix but at the end of each line.

logjs

(Optional, Boolean, default: FALSE) If true (default: false) the print_this string will also be printed to the javascript-console. This only makes sense, if the gui is active.

logfile_dir

(Optional, String, default: "tempdir()") The absolute path to folder where the logfile will be stored.

Value

No return value, called for side effects (see description)


miracum/misc-dizutils documentation built on Nov. 21, 2020, 7:41 p.m.