| <!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 into an R vector — convert_array • 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 into an R vector — convert_array"><meta name="description" content="Converts array 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. This function is an S3 generic |
| dispatching on to: developers may implement their own S3 methods for |
| custom vector types."><meta property="og:description" content="Converts array 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. This function is an S3 generic |
| dispatching on to: developers may implement their own S3 methods for |
| custom vector types."></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 into an R vector</h1> |
| <small class="dont-index">Source: <a href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/convert-array.R" class="external-link"><code>R/convert-array.R</code></a></small> |
| <div class="d-none name"><code>convert_array.Rd</code></div> |
| </div> |
| |
| <div class="ref-description section level2"> |
| <p>Converts <code>array</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. This function is an S3 generic |
| dispatching on <code>to</code>: developers may implement their own S3 methods for |
| custom vector types.</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</span><span class="op">(</span><span class="va">array</span>, to <span class="op">=</span> <span class="cn">NULL</span>, <span class="va">...</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">array<a class="anchor" aria-label="anchor" href="#arg-array"></a></dt> |
| <dd><p>A <a href="as_nanoarrow_array.html">nanoarrow_array</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--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt> |
| <dd><p>Passed to S3 methods</p></dd> |
| |
| </dl></div> |
| <div class="section level2"> |
| <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> |
| <p>An R vector of type <code>to</code>.</p> |
| </div> |
| <div class="section level2"> |
| <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2> |
| <p>Conversions are implemented for the following R vector types:</p><ul><li><p><code><a href="https://rdrr.io/r/base/logical.html" class="external-link">logical()</a></code>: Any numeric type can be converted to <code><a href="https://rdrr.io/r/base/logical.html" class="external-link">logical()</a></code> in addition |
| to the bool type. For numeric types, any non-zero value is considered <code>TRUE</code>.</p></li> |
| <li><p><code><a href="https://rdrr.io/r/base/integer.html" class="external-link">integer()</a></code>: Any numeric type can be converted to <code><a href="https://rdrr.io/r/base/integer.html" class="external-link">integer()</a></code>; however, |
| a warning will be signaled if the any value is outside the range of the |
| 32-bit integer.</p></li> |
| <li><p><code><a href="https://rdrr.io/r/base/double.html" class="external-link">double()</a></code>: Any numeric type can be converted to <code><a href="https://rdrr.io/r/base/double.html" class="external-link">double()</a></code>. This |
| conversion currently does not warn for values that may not roundtrip |
| through a floating-point double (e.g., very large uint64 and int64 values).</p></li> |
| <li><p><code><a href="https://rdrr.io/r/base/character.html" class="external-link">character()</a></code>: String and large string types can be converted to |
| <code><a href="https://rdrr.io/r/base/character.html" class="external-link">character()</a></code>. The conversion does not check for valid UTF-8: if you need |
| finer-grained control over encodings, use <code>to = blob::blob()</code>.</p></li> |
| <li><p><code><a href="https://rdrr.io/r/base/factor.html" class="external-link">factor()</a></code>: Dictionary-encoded arrays of strings can be converted to |
| <code><a href="https://rdrr.io/r/base/factor.html" class="external-link">factor()</a></code>; however, this must be specified explicitly (i.e., |
| <code>convert_array(array, factor())</code>) because arrays arriving |
| in chunks can have dictionaries that contain different levels. Use |
| <code>convert_array(array, factor(levels = c(...)))</code> to materialize an array |
| into a vector with known levels.</p></li> |
| <li><p><a href="https://rdrr.io/r/base/as.Date.html" class="external-link">Date</a>: Only the date32 type can be converted to an R Date vector.</p></li> |
| <li><p><code><a href="https://hms.tidyverse.org/reference/hms.html" class="external-link">hms::hms()</a></code>: Time32 and time64 types can be converted to <code><a href="https://hms.tidyverse.org/reference/hms.html" class="external-link">hms::hms()</a></code>.</p></li> |
| <li><p><code><a href="https://rdrr.io/r/base/difftime.html" class="external-link">difftime()</a></code>: Time32, time64, and duration types can be converted to |
| R <code><a href="https://rdrr.io/r/base/difftime.html" class="external-link">difftime()</a></code> vectors. The value is converted to match the <code><a href="https://rdrr.io/r/base/units.html" class="external-link">units()</a></code> |
| attribute of <code>to</code>.</p></li> |
| <li><p><code><a href="https://blob.tidyverse.org/reference/blob.html" class="external-link">blob::blob()</a></code>: String, large string, binary, and large binary types can |
| be converted to <code><a href="https://blob.tidyverse.org/reference/blob.html" class="external-link">blob::blob()</a></code>.</p></li> |
| <li><p><code><a href="https://vctrs.r-lib.org/reference/list_of.html" class="external-link">vctrs::list_of()</a></code>: List, large list, and fixed-size list types can be |
| converted to <code><a href="https://vctrs.r-lib.org/reference/list_of.html" class="external-link">vctrs::list_of()</a></code>.</p></li> |
| <li><p><code><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame()</a></code>: Struct types can be converted to <code><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame()</a></code>.</p></li> |
| <li><p><code><a href="https://vctrs.r-lib.org/reference/unspecified.html" class="external-link">vctrs::unspecified()</a></code>: Any type can be converted to <code><a href="https://vctrs.r-lib.org/reference/unspecified.html" class="external-link">vctrs::unspecified()</a></code>; |
| however, a warning will be raised if any non-null values are encountered.</p></li> |
| </ul><p>In addition to the above conversions, a null array may be converted to any |
| target prototype except <code><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame()</a></code>. Extension arrays are currently |
| converted as their storage type.</p> |
| </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">array</span> <span class="op"><-</span> <span class="fu"><a href="as_nanoarrow_array.html">as_nanoarrow_array</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</span><span class="op">(</span><span class="va">array</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</span><span class="op">(</span><span class="va">array</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': 5 obs. of 1 variable:</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ x: num 1 2 3 4 5</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> |
| |