File: addToLogger.Rd

package info (click to toggle)
r-cran-pkgmaker 0.32.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,192 kB
  • sloc: sh: 13; makefile: 2
file content (28 lines) | stat: -rw-r--r-- 925 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/unitTests.R
\name{addToLogger}
\alias{addToLogger}
\title{Enhancing RUnit Logger}
\usage{
addToLogger(name, value, logger = NULL)
}
\arguments{
\item{name}{name of the function or variable to add}

\item{value}{object to append to the logger.
If \code{value} is a function it is added to the list and is accessible via
\code{.testLogger$name}.
If \code{value} is a variable it is added to the local environment and is
therefore accessible in all logging functions.}

\item{logger}{an optional RUnit logger object.
If missing or \code{NULL}, the object \code{.testLogger} is searched in
\code{.GlobalEnv} -- and an error is thrown if it does not exist.}
}
\value{
the modified logger object. Note that the global object is also
modified if \code{logger} is \code{NULL}.
}
\description{
Adds a function or a local variable to RUnit global logger.
}