This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 394a2234 update documentation for tag main
394a2234 is described below
commit 394a2234564b6de6b6af34ee586e2a7922d9a78c
Author: GitHub Actions <[email protected]>
AuthorDate: Wed May 15 18:22:55 2024 +0000
update documentation for tag main
---
main/r/pkgdown.yml | 2 +-
main/r/reference/as_nanoarrow_vctr.html | 146 ++++++++++++++++++++++++++++++++
main/r/reference/index.html | 5 ++
main/r/reference/nanoarrow-package.html | 3 +-
main/r/search.json | 2 +-
main/r/sitemap.xml | 3 +
6 files changed, 158 insertions(+), 3 deletions(-)
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 15b78d68..3f283db6 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.9
pkgdown_sha: ~
articles: {}
-last_built: 2024-05-15T17:27Z
+last_built: 2024-05-15T18:22Z
diff --git a/main/r/reference/as_nanoarrow_vctr.html
b/main/r/reference/as_nanoarrow_vctr.html
new file mode 100644
index 00000000..201c3344
--- /dev/null
+++ b/main/r/reference/as_nanoarrow_vctr.html
@@ -0,0 +1,146 @@
+<!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"><meta name="description" content="This experimental vctr
class allows zero or more Arrow arrays to
+present as an R vector without converting them. This is useful for arrays
+with types that do not have a non-lossy R equivalent, and helps provide an
+intermediary object type where the default conversion is prohibitively
+expensive (e.g., a nested list of data frames). These objects will not
+survive many vctr transformations; however, they can be sliced without
+copying the underlying arrays."><title>Experimental Arrow encoded arrays as R
vectors — as_nanoarrow_vctr • 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><!-- Font
Awesome icons --><link rel="stylesheet" href="https://cdnjs.clou [...]
+present as an R vector without converting them. This is useful for arrays
+with types that do not have a non-lossy R equivalent, and helps provide an
+intermediary object type where the default conversion is prohibitively
+expensive (e.g., a nested list of data frames). These objects will not
+survive many vctr transformations; however, they can be sliced without
+copying the underlying arrays."><!-- mathjax --><script
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js";
integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k="
crossorigin="anonymous"></script><script
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js";
integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA="
crossorigin="anonymous"></script><!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js";></script>
+<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script>
+<![endif]--></head><body>
+ <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
+
+
+ <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"
data-bs-theme="light"><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.4.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><form class="form-inline my-2 my-lg-0" role="search">
+ <input type="search" class="form-control me-sm-2" aria-label="Toggle
navigation" name="search-input" data-search-index="../search.json"
id="search-input" placeholder="Search for" autocomplete="off"></form>
+
+ <ul class="navbar-nav"><li class="nav-item">
+ <a class="external-link nav-link"
href="https://github.com/apache/arrow-nanoarrow/"; aria-label="github">
+ <span class="fab 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">
+ <img src="" class="logo" alt=""><h1>Experimental Arrow encoded arrays as
R vectors</h1>
+ <small class="dont-index">Source: <a
href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/vctr.R";
class="external-link"><code>R/vctr.R</code></a></small>
+ <div class="d-none name"><code>as_nanoarrow_vctr.Rd</code></div>
+ </div>
+
+ <div class="ref-description section level2">
+ <p>This experimental vctr class allows zero or more Arrow arrays to
+present as an R vector without converting them. This is useful for arrays
+with types that do not have a non-lossy R equivalent, and helps provide an
+intermediary object type where the default conversion is prohibitively
+expensive (e.g., a nested list of data frames). These objects will not
+survive many vctr transformations; however, they can be sliced without
+copying the underlying arrays.</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">as_nanoarrow_vctr</span><span class="op">(</span><span
class="va">x</span>, <span class="va">...</span>, schema <span
class="op">=</span> <span class="cn">NULL</span>, subclass <span
class="op">=</span> <span class="fu"><a
href="https://rdrr.io/r/base/character.html";
class="external-link">character</a></span><span class="op">(</span><span
class="op">)</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">nanoarrow_vctr</span><span class="op">(</span>schema
<span class="op">=</span> <span class="cn">NULL</span>, subclass <span
class="op">=</span> <span class="fu"><a
href="https://rdrr.io/r/base/character.html";
class="external-link">character</a></span><span class="op">(</span><span
class="op">)</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>x</dt>
+<dd><p>An object that works with <code><a
href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream()</a></code>.</p></dd>
+
+
+<dt>...</dt>
+<dd><p>Passed to <code><a
href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream()</a></code></p></dd>
+
+
+<dt>schema</dt>
+<dd><p>An optional <code>schema</code></p></dd>
+
+
+<dt>subclass</dt>
+<dd><p>An optional subclass of nanoarrow_vctr to prepend to the
+final class name.</p></dd>
+
+</dl></div>
+ <div class="section level2">
+ <h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
+
+
+<p>A vctr of class 'nanoarrow_vctr'</p>
+ </div>
+ <div class="section level2">
+ <h2 id="details">Details<a class="anchor" aria-label="anchor"
href="#details"></a></h2>
+ <p>The nanoarrow_vctr is currently implemented similarly to <code><a
href="https://rdrr.io/r/base/factor.html";
class="external-link">factor()</a></code>: its
+storage type is an <code><a href="https://rdrr.io/r/base/integer.html";
class="external-link">integer()</a></code> that is a sequence along the total
length
+of the vctr and there are attributes that are required to resolve these
+indices to an array + offset. Sequences typically have a very compact
+representation in recent versions of R such that this has a cheap storage
+footprint even for large arrays. The attributes are
currently:</p><ul><li><p><code>schema</code>: The <a
href="as_nanoarrow_schema.html">nanoarrow_schema</a> shared by each
chunk.</p></li>
+<li><p><code>chunks</code>: A <code><a href="https://rdrr.io/r/base/list.html";
class="external-link">list()</a></code> of
<code>nanoarrow_array</code>.</p></li>
+<li><p><code>offsets</code>: An <code><a
href="https://rdrr.io/r/base/integer.html";
class="external-link">integer()</a></code> vector beginning with <code>0</code>
and followed by the
+cumulative length of each chunk. This allows the chunk index + offset
+to be resolved from a logical index with <code>log(n)</code>
complexity.</p></li>
+</ul><p>This implementation is preliminary and may change; however, the result
of
+<code>as_nanoarrow_array_stream(some_vctr[begin:end])</code> should remain
stable.</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="fl">1</span><span class="op">:</span><span
class="fl">5</span><span class="op">)</span></span></span>
+<span class="r-in"><span><span class="fu">as_nanoarrow_vctr</span><span
class="op">(</span><span class="va">array</span><span
class="op">)</span></span></span>
+<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_vctr
int32[5]></span>
+<span class="r-out co"><span class="r-pr">#></span> [1] 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"><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.0.9.</p>
+</div>
+
+ </footer></div>
+
+
+
+
+
+ </body></html>
+
diff --git a/main/r/reference/index.html b/main/r/reference/index.html
index 3921c2ba..dcf220d6 100644
--- a/main/r/reference/index.html
+++ b/main/r/reference/index.html
@@ -81,6 +81,11 @@
<dd>Convert an object to a nanoarrow schema</dd>
</dl><dl><dt>
+ <code><a
href="as_nanoarrow_vctr.html">as_nanoarrow_vctr()</a></code> <code><a
href="as_nanoarrow_vctr.html">nanoarrow_vctr()</a></code>
+ </dt>
+ <dd>Experimental Arrow encoded arrays as R vectors</dd>
+ </dl><dl><dt>
+
<code><a
href="basic_array_stream.html">basic_array_stream()</a></code>
</dt>
<dd>Create ArrayStreams from batches</dd>
diff --git a/main/r/reference/nanoarrow-package.html
b/main/r/reference/nanoarrow-package.html
index 90a7a363..dba2b4df 100644
--- a/main/r/reference/nanoarrow-package.html
+++ b/main/r/reference/nanoarrow-package.html
@@ -52,7 +52,8 @@
<div class="section level2">
<h2 id="see-also">See also<a class="anchor" aria-label="anchor"
href="#see-also"></a></h2>
- <div class="dont-index"><p>Useful links:</p><ul><li><p><a
href="https://github.com/apache/arrow-nanoarrow";
class="external-link">https://github.com/apache/arrow-nanoarrow</a></p></li>
+ <div class="dont-index"><p>Useful links:</p><ul><li><p><a
href="https://arrow.apache.org/nanoarrow/latest/r/";
class="external-link">https://arrow.apache.org/nanoarrow/latest/r/</a></p></li>
+<li><p><a href="https://github.com/apache/arrow-nanoarrow";
class="external-link">https://github.com/apache/arrow-nanoarrow</a></p></li>
<li><p>Report bugs at <a
href="https://github.com/apache/arrow-nanoarrow/issues";
class="external-link">https://github.com/apache/arrow-nanoarrow/issues</a></p></li>
</ul></div>
</div>
diff --git a/main/r/search.json b/main/r/search.json
index 1d02a1e9..168931a3 100644
--- a/main/r/search.json
+++ b/main/r/search.json
@@ -1 +1 @@
-[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections [...]
+[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections [...]
diff --git a/main/r/sitemap.xml b/main/r/sitemap.xml
index 253ca992..ae36c3c3 100644
--- a/main/r/sitemap.xml
+++ b/main/r/sitemap.xml
@@ -30,6 +30,9 @@
<url>
<loc>/reference/as_nanoarrow_schema.html</loc>
</url>
+ <url>
+ <loc>/reference/as_nanoarrow_vctr.html</loc>
+ </url>
<url>
<loc>/reference/basic_array_stream.html</loc>
</url>
