logging: Logging utilities

Description Usage Arguments Details Author(s)

Description

These are a set of utilities for logging messages to various logs. Many of the routines in this package use them to output additional diagnostic information which may help to track down problems.

Usage

1
2
3
4
5
6
	logMessage(text, logName)
	setLogConnection(logName, conn)
	setLogFile(logName, fileName)
	closeLogConnection(logName, allowFail=TRUE)
	logConnection(logName)
	availableLogs()

Arguments

text

Character vector of strings to write to log

logName

String name of a log

conn

A connection object

fileName

Name of the file that the log should point to

allowFail

Logical flag. If TRUE, will allow a closure of the log connection to fail, but will still disassociate the log with that connection. This is meant to be used with uncloseable connections such as stdout.

Details

The individual functions to the following: logMessage logs a message to a given log. setLogConnection points a log to a given connection, and setLogFile is a wrapper that points to a file connection. closeLogConnection tries to close a log and its connection. logConnection returns a log associated to a particular connection, and availableLogs lists the set of available logs.

Author(s)

Mango Solutions <support@mango-solutions.com>


RNMImport documentation built on May 2, 2019, 5:21 p.m.