File: pkgStartupMessage.Rd

package info (click to toggle)
r-cran-r.methodss3 1.8.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 300 kB
  • sloc: sh: 12; makefile: 2
file content (44 lines) | stat: -rw-r--r-- 1,238 bytes parent folder | download | duplicates (2)
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:
% 
%  pkgStartupMessage.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{pkgStartupMessage}
\alias{pkgStartupMessage.default}
\alias{pkgStartupMessage}

\title{Generates a (package) startup message}

\description{
  Generates a (package) startup message.
  Contrary to \code{\link[base]{packageStartupMessage}}(), this method does
  \emph{not} output a message when \code{library()/require()} is
  called with argument \code{quietly=TRUE}.
}

\usage{
\method{pkgStartupMessage}{default}(..., quietly=NA)
}

\arguments{
  \item{...}{Arguments passed to \code{\link[base]{packageStartupMessage}}().}
  \item{quietly}{If \code{\link[base:logical]{FALSE}}, the message is outputted, otherwise not.
    If \code{\link[base]{NA}}, the message is \emph{not} outputted if \code{\link[base]{library}}()
    (or \code{require()}) was called with argument \code{quietly=TRUE}.}
}

\value{
  Returns nothing.
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link[base]{packageStartupMessage}}().
}


\keyword{internal}