capture.html
2.76 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Capture printed output of an R expression in a string</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" href="../../R.css">
</head><body>
<table width="100%" summary="page for capture {gtools}"><tr><td>capture {gtools}</td><td align="right">R Documentation</td></tr></table>
<h2>Capture printed output of an R expression in a string</h2>
<h3>Description</h3>
<p>
Capture printed output of an R expression in a string
</p>
<h3>Usage</h3>
<pre>
capture(expression, collapse = "\n")
sprint(x,...)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>expression</code></td>
<td>
R expression whose output will be captured.</td></tr>
<tr valign="top"><td><code>collapse</code></td>
<td>
Character used to join output lines. Defaults to
"\n". Use <code>NULL</code> to return a vector of individual output lines.</td></tr>
<tr valign="top"><td><code>x</code></td>
<td>
Object to be printed</td></tr>
<tr valign="top"><td><code>...</code></td>
<td>
Optional parameters to be passed to <code><a href="../../stam/html/stam-internal.html">print</a></code> </td></tr>
</table>
<h3>Details</h3>
<p>
The <code>capture</code> function uses <code><a href="../../base/html/sink.html">sink</a></code> to capture the
printed results generated by <code>expression</code>.
</p>
<p>
The function <code>sprint</code> uses <code>capture</code> to redirect the
results of calling <code><a href="../../stam/html/stam-internal.html">print</a></code> on an object to a string.
</p>
<h3>Value</h3>
<p>
A character string, or if <code>collapse==NULL</code> a vector of character
strings containing the printed output from the R expression.</p>
<h3>WARNING</h3>
<p>
R 1.7.0+ includes <code>capture.output</code>, which
duplicates the functionality of <code>capture</code>. Thus, <code>capture</code>
is depreciated.
</p>
<h3>Author(s)</h3>
<p>
Gregory R. Warnes <a href="mailto:warnes@bst.rochester.edu">warnes@bst.rochester.edu</a>
</p>
<h3>See Also</h3>
<p>
<code><a href="../../session/html/texteval.html">texteval</a></code>, <code><a href="../../base/html/capture.output.html">capture.output</a></code>
</p>
<h3>Examples</h3>
<pre>
# capture the results of a loop
loop.text <- capture( for(i in 1:10) cat("i=",i,"\n") )
loop.text
# put regression summary results into a string
data(iris)
reg <- lm( Sepal.Length ~ Species, data=iris )
summary.text <- sprint( summary(reg) )
cat(summary.text)
</pre>
<hr><div align="center">[Package <em>gtools</em> version 2.4.0 <a href="00Index.html">Index]</a></div>
</body></html>