distrDoc-package {distrDoc} | R Documentation |
distrDoc provides documentation in form of a common vignette to packages distr, distrEx, distrSim, distrTEst, distrTeach, and distrMod.
Package: | distrDoc |
Version: | 2.0.3 |
Date: | 2008-11-27 |
Depends: | R(>= 2.6.0), tools, distr(>= 2.0.0), startupmsg |
LazyLoad: | yes |
License: | LGPL-3 |
URL: | http://distr.r-forge.r-project.org/ |
The idea to split off a common vignette for a set of packages in a particular documentation package is due to Seth Falcon.
You may suppress the start-up banner/message completely by setting options("StartupBanner"="off")
somewhere before loading this package by library
or require
in your R-code / R-session.
If option "StartupBanner"
is not defined (default) or setting
options("StartupBanner"=NULL)
or options("StartupBanner"="complete")
the complete start-up banner is displayed.
For any other value of option "StartupBanner"
(i.e., not in c(NULL,"off","complete")
)
only the version information is displayed.
The same can be achieved by wrapping the library
or require
call into
either suppressStartupMessages()
or onlytypeStartupMessages(.,atypes="version")
.
As for general packageStartupMessage
's, you may also suppress all
the start-up banner by wrapping the library
or require
call into suppressPackageStartupMessages()
from
startupmsg-version 0.5 on.
Peter Ruckdeschel Peter.Ruckdeschel@itwm.fraunhofer.de,
Thomas Stabla statho3@web.de,
Florian Camphausen fcampi@gmx.de,
Matthias Kohl Matthias.Kohl@stamats.de
Maintainer: Peter Ruckdeschel Peter.Ruckdeschel@itwm.fraunhofer.de
see mails "[Rd] package vignettes, suggests and R CMD check"
on r-devel by Seth Falcon,
https://stat.ethz.ch/pipermail/r-devel/2006-November/043702.html,
https://stat.ethz.ch/pipermail/r-devel/2006-November/043705.html,
and by the author,
https://stat.ethz.ch/pipermail/r-devel/2006-November/043700.html,
https://stat.ethz.ch/pipermail/r-devel/2006-November/043703.html
## Not run: ## Open the distr vignette vignette("distr") ## End(Not run)