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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
%
% hpaste.R
%
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\name{hpaste}
\alias{hpaste.default}
\alias{hpaste}
\title{Concatenating vectors into human-readable strings}
\description{
Concatenating vectors into human-readable strings such as "1, 2, 3, ..., 10".
}
\usage{
\method{hpaste}{default}(..., sep="", collapse=", ", lastCollapse=NULL,
maxHead=if (missing(lastCollapse)) 3 else Inf,
maxTail=if (is.finite(maxHead)) 1 else Inf, abbreviate="...", empty=character(0L))
}
\arguments{
\item{...}{Arguments to be pasted.}
\item{sep}{A \code{\link[base]{character}} string used to concatenate the arguments
in \code{...}, if more than one.}
\item{collapse, lastCollapse}{The \code{\link[base]{character}} strings to collapse
the elements together, where \code{lastCollapse} is specifying
the collapse string used between the last two elements.
If \code{lastCollapse} is \code{\link[base]{NULL}} (default), it is corresponds
to using the default collapse.}
\item{maxHead, maxTail, abbreviate}{Non-negative \code{\link[base]{integer}}s (also \code{\link[base:is.finite]{Inf}})
specifying the maximum number of elements of the beginning and
then end of the vector to be outputted. If \code{n = length(x)}
is greater than \code{maxHead+maxTail+1}, then \code{x} is
truncated to consist of \code{x[1:maxHead]}, \code{abbreviate},
and \code{x[(n-maxTail+1):n]}.}
\item{empty}{A \code{\link[base]{character}} string, or \code{character(0)} (default),
to be returned in case the result is of length zero.}
}
\value{
Returns a \code{\link[base]{character}} string.
}
\details{
\code{hpaste(..., sep=" ", maxHead=Inf)} corresponds to
\code{paste(..., sep=" ", collapse=", ")}.
}
\author{Henrik Bengtsson}
\examples{
# Some vectors
x <- 1:6
y <- 10:1
z <- LETTERS[x]
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Abbreviation of output vector
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
printf("x = \%s.\n", hpaste(x))
## x = 1, 2, 3, ..., 6.
printf("x = \%s.\n", hpaste(x, maxHead=2))
## x = 1, 2, ..., 6.
printf("x = \%s.\n", hpaste(x, maxHead=3)) # Default
## x = 1, 2, 3, ..., 6.
# It will never output 1, 2, 3, 4, ..., 6
printf("x = \%s.\n", hpaste(x, maxHead=4))
## x = 1, 2, 3, 4, 5, 6.
# Showing the tail
printf("x = \%s.\n", hpaste(x, maxHead=1, maxTail=2))
## x = 1, ..., 5, 6.
# Turning off abbreviation
printf("y = \%s.\n", hpaste(y, maxHead=Inf))
## y = 10, 9, 8, 7, 6, 5, 4, 3, 2, 1
## ...or simply
printf("y = \%s.\n", paste(y, collapse=", "))
## y = 10, 9, 8, 7, 6, 5, 4, 3, 2, 1
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Adding a special separator before the last element
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Change last separator
printf("x = \%s.\n", hpaste(x, lastCollapse=", and "))
## x = 1, 2, 3, 4, 5, and 6.
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Backward compatibility with paste()
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
s1 <- hpaste(x, maxHead=Inf)
s2 <- paste(x, collapse=", ")
printf("s = \%s.\n", s1);
stopifnot(identical(s1, s2))
s1 <- hpaste('<', x, '>', maxHead=Inf)
s2 <- paste('<', x, '>', sep="", collapse=", ")
printf("s = \%s.\n", s1);
stopifnot(identical(s1, s2))
s1 <- hpaste(x, y, z, sep="/", maxHead=Inf)
s2 <- paste(x, y, z, sep="/", collapse=", ")
printf("s = \%s.\n", s1);
stopifnot(identical(s1, s2))
s1 <- hpaste(x, collapse=NULL, maxHead=Inf)
s2 <- paste(x, collapse=NULL)
stopifnot(identical(s1, s2))
}
\seealso{
Internally \code{\link[base]{paste}}() is used.
}
\keyword{programming}
|
