File: ll.Package.Rd

package info (click to toggle)
r-cran-r.oo 1.21.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,796 kB
  • sloc: sh: 18; makefile: 2
file content (55 lines) | stat: -rwxr-xr-x 1,486 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
45
46
47
48
49
50
51
52
53
54
55
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  Package.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{ll.Package}
\alias{ll.Package}
\alias{Package.ll}
\alias{ll,Package-method}

\title{Generates a list of informative properties of all members of the package}

\description{
  Generates a list of informative properties of all members of the package.

  If the package is not loaded, it will be loaded, the members will be
  retrieved and then the package will be unloaded again.
}

\usage{
\method{ll}{Package}(this, envir=pos.to.env(getPosition(this)), ...)
}

\arguments{
  \item{...}{Not used.}
}

\value{
  Returns a \code{\link[base]{data.frame}}.
}

\details{
  Note the difference from the default definition of \code{ll()} as
  inherited from the \code{\link[R.oo]{Object}} class. Here \code{ll()} has been
  redefined to list the members of the package, i.e. the members in
  the environment on search path that belongs to the package, whereas
  the original usage was to list the members of the Object. However,
  since the internal members of Package object is not of interest we
  decided on this definition instead.
}

\examples{
  \dontrun{ll(R.oo)}
}

\author{Henrik Bengtsson}

\seealso{
  For more information see \code{\link{Package}}.
}
\keyword{internal}
\keyword{methods}