File: isVisible.Verbose.Rd

package info (click to toggle)
r-cran-r.utils 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,936 kB
  • sloc: sh: 18; makefile: 6
file content (44 lines) | stat: -rwxr-xr-x 1,195 bytes parent folder | download | duplicates (5)
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  Verbose.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{isVisible.Verbose}
\alias{isVisible.Verbose}
\alias{Verbose.isVisible}
\alias{isVisible,Verbose-method}

\title{Checks if a certain verbose level will be shown or not}

\description{
  Checks if a certain verbose level will be shown or not.
}

\usage{
\method{isVisible}{Verbose}(this, level=this$defaultLevel, ...)
}

\arguments{
 \item{level}{A \code{\link[base]{numeric}} value to be compared to the threshold.}
 \item{...}{Not used.}
}

\value{
  Returns \code{\link[base:logical]{TRUE}}, if given level is greater than (not equal to) the current
  threshold, otherwise \code{\link[base:logical]{FALSE}} is returned.
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link[R.utils:getThreshold.Verbose]{*getThreshold}()} and \code{\link[R.utils:setThreshold.Verbose]{*setThreshold}()}.
  For more information see \code{\link{Verbose}}.
}


\keyword{internal}
\keyword{methods}
\keyword{programming}