| feedback_get_formatted_string {DIZtools} | R Documentation |
Format the feedback string
Description
Helper function for the feedback function to combine the input parameters in proper manner to be a pretty and informative string which than can be added to the logfile and/or be displayed in the console. CAUTION: 'print_this' must be of length 1! For arrays loop through them by hand and call this function several times! Internal use. Use the robust 'feedback' function instead.
Usage
feedback_get_formatted_string(print_this, type, findme, prefix, suffix)
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://onlinetools.com/random/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. |
Value
Returns a properly an consistent formatted string containing the parameters handed over to this function.