0distrDoc-package: distrDoc - Documentation for 'distr' Family of R Packages

Description Details Acknowledgement Start-up-Banner Package versions Author(s) See Also Examples

Description

distrDoc provides documentation in form of a common vignette to packages distr, distrEx, distrSim, distrTEst, distrTeach, distrMod, and distrEllipse.

Details

Package: distrDoc
Version: 2.8.0
Date: 2019-03-11
Depends: R(>= 2.14.0)
Imports: distr(>= 2.2.0), distrEx(>= 2.2.0), distrSim(>= 2.2.0), distrTEst(>= 2.2.0), distrTeach(>= 2.2.0), RandVar(>= 0.7), distrMod(>= 2.2.0), MASS, methods, SweaveListingUtils, startupmsg
Suggests: Biobase
ByteCompile: yes
License: LGPL-3
URL: http://distr.r-forge.r-project.org/
VCS/SVNRevision: 1314

Acknowledgement

The idea to split off a common vignette for a set of packages in a particular documentation package is due to Seth Falcon.

Start-up-Banner

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.

Package versions

Note: The first two numbers of package versions do not necessarily reflect package-individual development, but rather are chosen for the distrXXX family as a whole in order to ease updating "depends" information.

Author(s)

Peter Ruckdeschel peter.ruckdeschel@uni-oldenburg.de,
Thomas Stabla statho3@web.de,
Florian Camphausen fcampi@gmx.de,
Matthias Kohl Matthias.Kohl@stamats.de

Maintainer: Peter Ruckdeschel peter.ruckdeschel@uni-oldenburg.de

See Also

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

Examples

1
2
3
4
5
## Not run: 
## Open the distr vignette
     vignette("distr")

## End(Not run)

distrDoc documentation built on May 2, 2019, 10:59 a.m.