Package 'PEcAn.logger'

Prints a debug message.

Description

This function will print a debug message.

Usage

logger.debug(msg, ...)

Arguments

msg	the message that should be printed.
...	any additional text that should be printed.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.debug('variable', 5)

## End(Not run)

---

Prints an error message.

Description

This function will print an error message.

Usage

logger.error(msg, ...)

Arguments

msg	the message that should be printed.
...	any additional text that should be printed.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.error('system did not converge')

## End(Not run)

---

Get configured logging level.

Description

This will return the current level configured of the logging messages.

Usage

logger.getLevel()

Details

Note that logger.setLevel() invisibly returns current level, so logger.getLevel() is not required to restore the level after a temporary change.

Value

A string giving the lowest message level that will be reported, one of "ALL", "DEBUG", "INFO", "WARN", "ERROR", "SEVERE", or "OFF".

Author(s)

Rob Kooper

Examples

## Not run: 
logger.getLevel()

## End(Not run)

---

Prints an informational message.

Description

This function will print an informational message.

Usage

logger.info(msg, ...)

Arguments

msg	the message that should be printed.
...	any additional text that should be printed.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.info('PEcAn version 1.2')

## End(Not run)

---

Prints a message at a certain log level.

Description

This function will print a message. This is the function that is responsible for the actual printing of the message.

Usage

logger.message(level, msg, ..., wrap = TRUE)

Arguments

level	the level of the message (DEBUG, INFO, WARN, ERROR)
msg	the message that should be printed.
...	any additional text that should be printed.
wrap	Whether or not to wrap long messages (default = TRUE). If FALSE, preserve format of original string. Useful for specifically formatted error messages.

Details

This is a place holder and will be later filled in with a more complex logging set

Author(s)

Rob Kooper

Examples

## Not run: 
logger.message('DEBUG', 'variable', 5)

## End(Not run)

---

Configure logging level.

Description

This will configure the logger level. This allows to turn DEBUG, INFO, WARN, ERROR, and SEVERE messages on and off.

Usage

logger.setLevel(level)

Arguments

level

the level of the message. One of "ALL", "DEBUG", "INFO", "WARN", "ERROR", "SEVERE", or "OFF".

Details

Note that this controls printing of messages and does not change other behavior. In particular, suppressing SEVERE by setting the level to "OFF" does not prevent logger.severe() from signaling an error (and terminating the program if logger.setQuitOnSevere(TRUE)).

Value

When logger level is set, the previous level is returned invisibly. This can be passed to logger.setLevel() to restore the previous level.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.setLevel('DEBUG')

# Temporarily turn logger off
old_logger_level <- logger.setLevel("OFF")
  # code here
logger.setLevel(old_logger_level)

## End(Not run)

---

Configure logging output filename.

Description

The name of the file where the logging information should be written to.

Usage

logger.setOutputFile(filename)

Arguments

filename

the file to send the log messages to (or NA to not write to file)

Value

Invisibly, the previously set filename. This can be used to restore settings after a temporary change.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.setOutputFile('pecan.log')

## End(Not run)

---

Configure whether severe should quit.

Description

The default is for a non-interactive session to quit. Setting this to false is especially useful for running tests.

Usage

logger.setQuitOnSevere(severeQuits)

Arguments

severeQuits

should R quit on a severe error.

Value

invisibly, the previous value of severeQuits. This can be used to restore settings after a temporary change.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.setQuitOnSevere(FALSE)

## End(Not run)

---

Configure logging to console.

Description

Should the logging to be printed to the console or not.

Usage

logger.setUseConsole(console, stderr = TRUE)

Arguments

console	set to true to print logging to console.
stderr	set to true (default) to log to stderr instead of stdout

Value

Invisibly, a list of the previously set values of console and stderr. This can be used to restore the previous settings after a temporary change.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.setUseConsole(TRUE)

## End(Not run)

---

Configure the number of chars per line

Description

The default is for 60 chars per line. Setting this to any value will wrap the line when printing a message at that many chars.

Usage

logger.setWidth(width)

Arguments

width

number of chars to print before wrapping to next line.

Value

Invisibly, the previously set width. This can be used to restore settings after a temporary change.

Author(s)

David LeBauer

Examples

## Not run: 
logger.setWidth(70)

## End(Not run)

---

Prints a severe message and stops execution.

Description

This function will print a message and stop execution of the code. This should only be used if the application should terminate.

Usage

logger.severe(msg, ..., wrap = TRUE)

Arguments

msg	the message that should be printed.
...	any additional text that should be printed.
wrap	Whether or not to wrap long messages (default = TRUE). If FALSE, preserve format of original string. Useful for specifically formatted error messages.

Details

Set logger.setQuitOnSevere(FALSE) to avoid terminating the session. The default is to not quit if running interactively.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.severe('missing parameters')

## End(Not run)

---

Prints a warning message.

Description

This function will print a warning message.

Usage

logger.warn(msg, ...)

Arguments

msg	the message that should be printed.
...	any additional text that should be printed.

Author(s)

Rob Kooper

Examples

## Not run: 
logger.warn('detected NA values')

## End(Not run)

---

Convert the printed output of an object to a string. This is particularly useful for passing complex objects (e.g. matrices, data.frames) to simple printing functions like logger.info() or base::message().

Description

Note that for this to work properly in the PEcAn.logger functions, you should always add the wrap = FALSE argument, and probably add a newline ("\n") before the output of this function.

Usage

print2string(x, ...)

Arguments

x	Object to print
...	Additional arguments to base::print().

Value

Output of print(x, ...), captured as string

Author(s)

Alexey Shiklomanov

Examples

logger.info("First few rows of Iris:\n", print2string(iris[1:10, -5]), wrap = FALSE)
df <- data.frame(test = c("download", "process", "plot"), status = c(TRUE, TRUE, FALSE))
logger.debug("Current status:\n", print2string(df, row.names = FALSE), wrap = FALSE)

---

Logger message if conditions are not met

Description

Similar to base::stopifnot, but allows you to use a custom message and logger level. If all conditions are TRUE, silently exit.

Usage

severeifnot(msg, ...)

errorifnot(msg, ...)

warnifnot(msg, ...)

infoifnot(msg, ...)

debugifnot(msg, ...)

Arguments

msg	Logger message to write, as a single character string.
...	Conditions to evaluate

Details

Conditions can be vectorized, or can return non-logical values.The underlying function automatically applies isTRUE(all(.)) to the conditions.

Value

Invisibly, TRUE if conditions are met, FALSE otherwise

Examples

a <- 1:5
b <- list(6, 7, 8)
debugifnot("By the way, something is not a list.", is.list(a), is.list(b))
infoifnot("Something is not a list.", is.list(a), is.list(b))
warnifnot("I would prefer it if you used lists.", is.list(a), is.list(b))
errorifnot("You should definitely use lists.", is.list(a), is.list(b))
try({
  severeifnot("I cannot deal with the fact that something is not a list.",
    is.list(a),
    is.list(b))
})

---