| Line 1... |
Line 1... |
| 1 |
% File src/library/utils/man/str.Rd
|
1 |
% File src/library/utils/man/str.Rd
|
| 2 |
% Part of the R package, https://www.R-project.org
|
2 |
% Part of the R package, https://www.R-project.org
|
| 3 |
% Copyright 1995-2016 R Core Team
|
3 |
% Copyright 1995-2019 R Core Team
|
| 4 |
% Distributed under GPL 2 or later
|
4 |
% Distributed under GPL 2 or later
|
| 5 |
|
5 |
|
| 6 |
\name{str}
|
6 |
\name{str}
|
| 7 |
\title{Compactly Display the Structure of an Arbitrary R Object}
|
7 |
\title{Compactly Display the Structure of an Arbitrary R Object}
|
| 8 |
\alias{str}
|
8 |
\alias{str}
|
| Line 22... |
Line 22... |
| 22 |
width = getOption("width"), nest.lev = 0,
|
22 |
width = getOption("width"), nest.lev = 0,
|
| 23 |
indent.str = paste(rep.int(" ", max(0, nest.lev + 1)),
|
23 |
indent.str = paste(rep.int(" ", max(0, nest.lev + 1)),
|
| 24 |
collapse = ".."),
|
24 |
collapse = ".."),
|
| 25 |
comp.str = "$ ", no.list = FALSE, envir = baseenv(),
|
25 |
comp.str = "$ ", no.list = FALSE, envir = baseenv(),
|
| 26 |
strict.width = strO$strict.width,
|
26 |
strict.width = strO$strict.width,
|
| 27 |
formatNum = strO$formatNum, list.len = 99, \dots)
|
27 |
formatNum = strO$formatNum, list.len = strO$list.len,
|
| - |
|
28 |
deparse.lines = strO$deparse.lines, \dots)
|
| 28 |
|
29 |
|
| 29 |
strOptions(strict.width = "no", digits.d = 3, vec.len = 4,
|
30 |
strOptions(strict.width = "no", digits.d = 3, vec.len = 4,
|
| - |
|
31 |
list.len = 99, deparse.lines = NULL,
|
| 30 |
drop.deparse.attr = TRUE,
|
32 |
drop.deparse.attr = TRUE,
|
| 31 |
formatNum = function(x, ...)
|
33 |
formatNum = function(x, ...)
|
| 32 |
format(x, trim = TRUE, drop0trailing = TRUE, ...))
|
34 |
format(x, trim = TRUE, drop0trailing = TRUE, ...))
|
| 33 |
}
|
35 |
}
|
| 34 |
\description{
|
36 |
\description{
|
| Line 96... |
Line 98... |
| 96 |
component of option \code{"str"}, see \dQuote{Usage} of
|
98 |
component of option \code{"str"}, see \dQuote{Usage} of
|
| 97 |
\code{strOptions()} above, which is almost back compatible to \R
|
99 |
\code{strOptions()} above, which is almost back compatible to \R
|
| 98 |
<= 2.7.x, however, using \code{\link{formatC}} may be slightly better.}
|
100 |
<= 2.7.x, however, using \code{\link{formatC}} may be slightly better.}
|
| 99 |
\item{list.len}{numeric; maximum number of list elements to display
|
101 |
\item{list.len}{numeric; maximum number of list elements to display
|
| 100 |
within a level.}
|
102 |
within a level.}
|
| - |
|
103 |
\item{deparse.lines}{numeric or \code{NULL} as by default, determining the
|
| - |
|
104 |
\code{nlines} argument to \code{\link{deparse}()} when \code{object} is
|
| - |
|
105 |
a \code{\link{call}}. When \code{NULL}, the \code{nchar.max} and
|
| - |
|
106 |
\code{width} arguments are used to determine a smart default.}
|
| 101 |
\item{\dots}{potential further arguments (required for Method/Generic
|
107 |
\item{\dots}{potential further arguments (required for Method/Generic
|
| 102 |
reasons).}
|
108 |
reasons).}
|
| 103 |
}
|
109 |
}
|
| 104 |
\value{
|
110 |
\value{
|
| 105 |
\code{str} does not return anything, for efficiency reasons.
|
111 |
\code{str} does not return anything, for efficiency reasons.
|
The R Project SVN
R