| <!DOCTYPE html> |
| <!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Convert an Array Stream into an R vector — convert_array_stream • nanoarrow</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Convert an Array Stream into an R vector — convert_array_stream"><meta name="description" content="Converts array_stream to the type specified by to. This is a low-level |
| interface; most users should use as.data.frame() or as.vector() unless |
| finer-grained control is needed over the conversion. See convert_array() |
| for details of the conversion process; see infer_nanoarrow_ptype() for |
| default inferences of to."><meta property="og:description" content="Converts array_stream to the type specified by to. This is a low-level |
| interface; most users should use as.data.frame() or as.vector() unless |
| finer-grained control is needed over the conversion. See convert_array() |
| for details of the conversion process; see infer_nanoarrow_ptype() for |
| default inferences of to."></head><body> |
| <a href="#main" class="visually-hidden-focusable">Skip to contents</a> |
| |
| |
| <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container"> |
| |
| <a class="navbar-brand me-2" href="../index.html">nanoarrow</a> |
| |
| <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.5.0.9000</small> |
| |
| |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| |
| <div id="navbar" class="collapse navbar-collapse ms-3"> |
| <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li> |
| <li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li> |
| </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search"> |
| <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li> |
| <li class="nav-item"><a class="external-link nav-link" href="https://github.com/apache/arrow-nanoarrow/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li> |
| </ul></div> |
| |
| |
| </div> |
| </nav><div class="container template-reference-topic"> |
| <div class="row"> |
| <main id="main" class="col-md-9"><div class="page-header"> |
| |
| <h1>Convert an Array Stream into an R vector</h1> |
| <small class="dont-index">Source: <a href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/convert-array-stream.R" class="external-link"><code>R/convert-array-stream.R</code></a></small> |
| <div class="d-none name"><code>convert_array_stream.Rd</code></div> |
| </div> |
| |
| <div class="ref-description section level2"> |
| <p>Converts <code>array_stream</code> to the type specified by <code>to</code>. This is a low-level |
| interface; most users should use <code><a href="https://rdrr.io/r/base/as.data.frame.html" class="external-link">as.data.frame()</a></code> or <code><a href="https://rdrr.io/r/base/vector.html" class="external-link">as.vector()</a></code> unless |
| finer-grained control is needed over the conversion. See <code><a href="convert_array.html">convert_array()</a></code> |
| for details of the conversion process; see <code><a href="infer_nanoarrow_ptype.html">infer_nanoarrow_ptype()</a></code> for |
| default inferences of <code>to</code>.</p> |
| </div> |
| |
| <div class="section level2"> |
| <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2> |
| <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">convert_array_stream</span><span class="op">(</span><span class="va">array_stream</span>, to <span class="op">=</span> <span class="cn">NULL</span>, size <span class="op">=</span> <span class="cn">NULL</span>, n <span class="op">=</span> <span class="cn">Inf</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">collect_array_stream</span><span class="op">(</span><span class="va">array_stream</span>, n <span class="op">=</span> <span class="cn">Inf</span>, schema <span class="op">=</span> <span class="cn">NULL</span>, validate <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div> |
| </div> |
| |
| <div class="section level2"> |
| <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2> |
| |
| |
| <dl><dt id="arg-array-stream">array_stream<a class="anchor" aria-label="anchor" href="#arg-array-stream"></a></dt> |
| <dd><p>A <a href="as_nanoarrow_array_stream.html">nanoarrow_array_stream</a>.</p></dd> |
| |
| |
| <dt id="arg-to">to<a class="anchor" aria-label="anchor" href="#arg-to"></a></dt> |
| <dd><p>A target prototype object describing the type to which <code>array</code> |
| should be converted, or <code>NULL</code> to use the default conversion as |
| returned by <code><a href="infer_nanoarrow_ptype.html">infer_nanoarrow_ptype()</a></code>. Alternatively, a function can be |
| passed to perform an alternative calculation of the default ptype as |
| a function of <code>array</code> and the default inference of the prototype.</p></dd> |
| |
| |
| <dt id="arg-size">size<a class="anchor" aria-label="anchor" href="#arg-size"></a></dt> |
| <dd><p>The exact size of the output, if known. If specified, |
| slightly more efficient implementation may be used to collect the output.</p></dd> |
| |
| |
| <dt id="arg-n">n<a class="anchor" aria-label="anchor" href="#arg-n"></a></dt> |
| <dd><p>The maximum number of batches to pull from the array stream.</p></dd> |
| |
| |
| <dt id="arg-schema">schema<a class="anchor" aria-label="anchor" href="#arg-schema"></a></dt> |
| <dd><p>A <a href="as_nanoarrow_schema.html">nanoarrow_schema</a> or <code>NULL</code> to guess |
| based on the first schema.</p></dd> |
| |
| |
| <dt id="arg-validate">validate<a class="anchor" aria-label="anchor" href="#arg-validate"></a></dt> |
| <dd><p>Use <code>FALSE</code> to skip the validation step (i.e., if you |
| know that the arrays are valid).</p></dd> |
| |
| </dl></div> |
| <div class="section level2"> |
| <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> |
| |
| <ul><li><p><code>convert_array_stream()</code>: An R vector of type <code>to</code>.</p></li> |
| <li><p><code>collect_array_stream()</code>: A <code><a href="https://rdrr.io/r/base/list.html" class="external-link">list()</a></code> of <a href="as_nanoarrow_array.html">nanoarrow_array</a></p></li> |
| </ul></div> |
| |
| <div class="section level2"> |
| <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2> |
| <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">stream</span> <span class="op"><-</span> <span class="fu"><a href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>x <span class="op">=</span> <span class="fl">1</span><span class="op">:</span><span class="fl">5</span><span class="op">)</span><span class="op">)</span></span></span> |
| <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/str.html" class="external-link">str</a></span><span class="op">(</span><span class="fu">convert_array_stream</span><span class="op">(</span><span class="va">stream</span><span class="op">)</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> 'data.frame': 5 obs. of 1 variable:</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ x: int 1 2 3 4 5</span> |
| <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/str.html" class="external-link">str</a></span><span class="op">(</span><span class="fu">convert_array_stream</span><span class="op">(</span><span class="va">stream</span>, to <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>x <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/double.html" class="external-link">double</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> 'data.frame': 0 obs. of 1 variable:</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ x: num </span> |
| <span class="r-in"><span></span></span> |
| <span class="r-in"><span><span class="va">stream</span> <span class="op"><-</span> <span class="fu"><a href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>x <span class="op">=</span> <span class="fl">1</span><span class="op">:</span><span class="fl">5</span><span class="op">)</span><span class="op">)</span></span></span> |
| <span class="r-in"><span><span class="fu">collect_array_stream</span><span class="op">(</span><span class="va">stream</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> [[1]]</span> |
| <span class="r-out co"><span class="r-pr">#></span> <nanoarrow_array struct[5]></span> |
| <span class="r-out co"><span class="r-pr">#></span> $ length : int 5</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ null_count: int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ offset : int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ buffers :List of 1</span> |
| <span class="r-out co"><span class="r-pr">#></span> ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ children :List of 1</span> |
| <span class="r-out co"><span class="r-pr">#></span> ..$ x:<nanoarrow_array int32[5]></span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ length : int 5</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ null_count: int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ offset : int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ buffers :List of 2</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. .. ..$ :<nanoarrow_buffer validity<bool>[0][0 b]> ``</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. .. ..$ :<nanoarrow_buffer data<int32>[5][20 b]> `1 2 3 4 5`</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ dictionary: NULL</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ children : list()</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ dictionary: NULL</span> |
| <span class="r-out co"><span class="r-pr">#></span> </span> |
| <span class="r-in"><span></span></span> |
| </code></pre></div> |
| </div> |
| </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2> |
| </nav></aside></div> |
| |
| |
| <footer><div class="pkgdown-footer-left"> |
| <p>Developed by Dewey Dunnington, Apache Arrow.</p> |
| </div> |
| |
| <div class="pkgdown-footer-right"> |
| <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.</p> |
| </div> |
| |
| </footer></div> |
| |
| |
| |
| |
| |
| </body></html> |
| |
