File: ll.Rd

package info (click to toggle)
gdata 3.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 964 kB
  • sloc: sh: 27; makefile: 15
file content (66 lines) | stat: -rw-r--r-- 2,115 bytes parent folder | download
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
56
57
58
59
60
61
62
63
64
65
66
\name{ll}
\alias{ll}
\title{Describe Objects or Elements}
\description{
  Display name, class, size, and dimensions of each object in a given
  environment. Alternatively, if the main argument is an object, its
  elements are listed and described.
}
\usage{
ll(pos=1, unit="KB", digits=0, dim=FALSE, sort=FALSE, class=NULL,
   invert=FALSE, \dots)
}
\arguments{
  \item{pos}{environment position number, environment name, data frame,
    list, model, S4 object, or any object that \code{is.list}.}
  \item{unit}{unit for displaying object size: "B", "KB", "MB", "GB", or
    first letter (case-insensitive).}
  \item{digits}{number of decimals to display when rounding object
    size.}
  \item{dim}{whether object dimensions should be returned.}
  \item{sort}{whether elements should be sorted by name.}
  \item{class}{character vector for limiting the output to specified
    classes.}
  \item{invert}{whether to invert the \code{class} filter, so specified
    classes are excluded.}
  \item{\dots}{passed to \code{ls}.}
}
\value{
  A data frame with named rows and the following columns:
  \item{Class}{object class.}
  \item{KB}{object size \emph{(see note)}.}
  \item{Dim}{object dimensions \emph{(optional)}.}
}
\note{The name of the object size column is the same as the unit used.}
\author{Arni Magnusson, with contributions by Jim Rogers and Michael
  Chirico.}
\seealso{
  \code{ll} is a verbose alternative to \code{\link{ls}} (objects in an
  environment), \code{\link{names}} (elements in a list-like object),
  and \code{\link{slotNames}} (S4 object).

  \code{\link{str}} and \code{\link{summary}} also describe elements in
  a list-like objects.

  \code{\link{env}} is a related function that describes all loaded
  environments.
}
\examples{
ll()
ll(all=TRUE)
ll("package:base")
ll("package:base", class="function", invert=TRUE)

ll(infert)
model <- glm(case~spontaneous+induced, family=binomial, data=infert)
ll(model, dim=TRUE)
ll(model, sort=TRUE)
ll(model$family)
}
\keyword{data}
\keyword{attribute}
\keyword{classes}
\keyword{list}
\keyword{environment}
\keyword{print}
\keyword{utilities}