R/log4r-package.R

In log4r: A Fast and Lightweight Logging System for R, Based on 'log4j'

#' A simple logging system for R, based on log4j.
#'
#' logr4 provides an object-oriented logging system that uses an API roughly
#' equivalent to log4j and its related variants.
#'
#' \tabular{ll}{
#' Package: \tab log4r\cr
#' Type: \tab Package\cr
#' Version: \tab 0.2\cr
#' Date: \tab 2014-09-29\cr
#' License: \tab Artistic-2.0\cr
#' LazyLoad: \tab yes\cr }

#' Maintainer: Kirill Müller <krlmlr+r@@mailbox.org>
#'
#' URL: \url{https://github.com/johnmyleswhite/log4r}
#'
#' Issue tracker: \url{https://github.com/johnmyleswhite/log4r/issues}
#'
#' @name log4r-package
#' @aliases log4r-package log4r
#' @docType package
#' @references See the log4j documentation or the documentation for its many
#' derivatives to understand the origins of this logging system.
#' @keywords package
#' @examples
#'
#' # Import the log4r package.
#' library('log4r')
#'
#' # Create a new logger object with create.logger().
#' logger <- create.logger()
#'
#' # Set the logger's file output.
#' logfile(logger) <- 'base.log'
#'
#' # Set the current level of the logger.
#' level(logger) <- 'INFO'
#'
#' # Try logging messages with different priorities.
#' # At priority level INFO, a call to debug() won't print anything.
#' debug(logger, 'A Debugging Message')
#' info(logger, 'An Info Message')
#' warn(logger, 'A Warning Message')
#' error(logger, 'An Error Message')
#' fatal(logger, 'A Fatal Error Message')
#' @useDynLib log4r, .registration = TRUE
NULL