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 5019f97c update documentation for tag main
5019f97c is described below
commit 5019f97cb8288026bb099ddeabf31c65c36dbd68
Author: GitHub Actions <[email protected]>
AuthorDate: Sat Mar 29 19:33:38 2025 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1159841 -> 1159841
bytes
main/r/pkgdown.yml | 2 +-
...oarrow_version.html => example_ipc_stream.html} | 28 ++++++++++-----------
main/r/reference/index.html | 10 ++++++--
main/r/reference/nanoarrow_version.html | 7 ++++--
main/r/reference/read_nanoarrow.html | 12 ++++-----
main/r/search.json | 2 +-
main/r/sitemap.xml | 1 +
8 files changed, 35 insertions(+), 27 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 6c6f2d55..b05684e5 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 427f2d73..f7171bf2 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-03-28T17:05Z
+last_built: 2025-03-29T19:33Z
diff --git a/main/r/reference/nanoarrow_version.html
b/main/r/reference/example_ipc_stream.html
similarity index 51%
copy from main/r/reference/nanoarrow_version.html
copy to main/r/reference/example_ipc_stream.html
index 5f8ff9e7..e3848838 100644
--- a/main/r/reference/nanoarrow_version.html
+++ b/main/r/reference/example_ipc_stream.html
@@ -1,5 +1,5 @@
<!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>Underlying 'nanoarrow' C library build —
nanoarrow_version • nanoarrow</title><script
src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport"
content="width=device [...]
+<!-- 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>Example Arrow IPC Data — example_ipc_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 [...]
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
@@ -28,40 +28,40 @@
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
- <h1>Underlying 'nanoarrow' C library build</h1>
- <small class="dont-index">Source: <a
href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/nanoarrow-package.R";
class="external-link"><code>R/nanoarrow-package.R</code></a></small>
- <div class="d-none name"><code>nanoarrow_version.Rd</code></div>
+ <h1>Example Arrow IPC Data</h1>
+ <small class="dont-index">Source: <a
href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/ipc.R";
class="external-link"><code>R/ipc.R</code></a></small>
+ <div class="d-none name"><code>example_ipc_stream.Rd</code></div>
</div>
<div class="ref-description section level2">
- <p>Underlying 'nanoarrow' C library build</p>
+ <p>An example stream that can be used for testing or examples.</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">nanoarrow_version</span><span class="op">(</span>runtime <span
class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span></code></pre></div>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span
class="fu">example_ipc_stream</span><span class="op">(</span>compression <span
class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html";
class="external-link">c</a></span><span class="op">(</span><span
class="st">"none"</span>, <span class="st">"zstd"</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 id="arg-runtime">runtime<a class="anchor" aria-label="anchor"
href="#arg-runtime"></a></dt>
-<dd><p>Compare TRUE and FALSE values to detect a
-possible ABI mismatch.</p></dd>
+<dl><dt id="arg-compression">compression<a class="anchor" aria-label="anchor"
href="#arg-compression"></a></dt>
+<dd><p>One of "none" or "zstd"</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
- <p>A string identifying the version of nanoarrow this package
-was compiled against.</p>
+ <p>A raw vector that can be passed to <code><a
href="read_nanoarrow.html">read_nanoarrow()</a></code></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="fu">nanoarrow_version</span><span
class="op">(</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> [1]
"0.7.0-SNAPSHOT"</span>
-<span class="r-in"><span></span></span>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/as.data.frame.html";
class="external-link">as.data.frame</a></span><span class="op">(</span><span
class="fu"><a href="read_nanoarrow.html">read_nanoarrow</a></span><span
class="op">(</span><span class="fu">example_ipc_stream</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> some_col</span>
+<span class="r-out co"><span class="r-pr">#></span> 1 0</span>
+<span class="r-out co"><span class="r-pr">#></span> 2 1</span>
+<span class="r-out co"><span class="r-pr">#></span> 3 2</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of
contents"><h2>On this page</h2>
diff --git a/main/r/reference/index.html b/main/r/reference/index.html
index f27fe217..b2d7b412 100644
--- a/main/r/reference/index.html
+++ b/main/r/reference/index.html
@@ -98,6 +98,12 @@
<dd>Convert an Array Stream into an R vector</dd>
</dl><dl><dt>
+ <code><a
href="example_ipc_stream.html">example_ipc_stream()</a></code>
+
+ </dt>
+ <dd>Example Arrow IPC Data</dd>
+ </dl><dl><dt>
+
<code><a
href="infer_nanoarrow_ptype.html">infer_nanoarrow_ptype()</a></code>
</dt>
@@ -152,13 +158,13 @@
<dd>Danger zone: low-level pointer operations</dd>
</dl><dl><dt>
- <code><a href="nanoarrow_version.html">nanoarrow_version()</a></code>
+ <code><a
href="nanoarrow_version.html">nanoarrow_version()</a></code> <code><a
href="nanoarrow_version.html">nanoarrow_with_zstd()</a></code>
</dt>
<dd>Underlying 'nanoarrow' C library build</dd>
</dl><dl><dt>
- <code><a href="read_nanoarrow.html">read_nanoarrow()</a></code>
<code><a href="read_nanoarrow.html">write_nanoarrow()</a></code> <code><a
href="read_nanoarrow.html">example_ipc_stream()</a></code>
+ <code><a href="read_nanoarrow.html">read_nanoarrow()</a></code>
<code><a href="read_nanoarrow.html">write_nanoarrow()</a></code>
</dt>
<dd>Read/write serialized streams of Arrow data</dd>
diff --git a/main/r/reference/nanoarrow_version.html
b/main/r/reference/nanoarrow_version.html
index 5f8ff9e7..e199525a 100644
--- a/main/r/reference/nanoarrow_version.html
+++ b/main/r/reference/nanoarrow_version.html
@@ -39,7 +39,9 @@
<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">nanoarrow_version</span><span class="op">(</span>runtime <span
class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span></code></pre></div>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span
class="fu">nanoarrow_version</span><span class="op">(</span>runtime <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">nanoarrow_with_zstd</span><span
class="op">(</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
@@ -61,7 +63,8 @@ was compiled against.</p>
<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="fu">nanoarrow_version</span><span
class="op">(</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1]
"0.7.0-SNAPSHOT"</span>
-<span class="r-in"><span></span></span>
+<span class="r-in"><span><span class="fu">nanoarrow_with_zstd</span><span
class="op">(</span><span class="op">)</span></span></span>
+<span class="r-out co"><span class="r-pr">#></span> [1] TRUE</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of
contents"><h2>On this page</h2>
diff --git a/main/r/reference/read_nanoarrow.html
b/main/r/reference/read_nanoarrow.html
index fdeb931f..5873b8e5 100644
--- a/main/r/reference/read_nanoarrow.html
+++ b/main/r/reference/read_nanoarrow.html
@@ -56,9 +56,7 @@ a CSV file that does a better job maintaining types.</p>
<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">read_nanoarrow</span><span class="op">(</span><span
class="va">x</span>, <span class="va">...</span>, lazy <span
class="op">=</span> <span class="cn">FALSE</span><span
class="op">)</span></span>
<span></span>
-<span><span class="fu">write_nanoarrow</span><span class="op">(</span><span
class="va">data</span>, <span class="va">x</span>, <span
class="va">...</span><span class="op">)</span></span>
-<span></span>
-<span><span class="fu">example_ipc_stream</span><span class="op">(</span><span
class="op">)</span></span></code></pre></div>
+<span><span class="fu">write_nanoarrow</span><span class="op">(</span><span
class="va">data</span>, <span class="va">x</span>, <span
class="va">...</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
@@ -103,11 +101,11 @@ and the recommended file extension is
<code>.arrows</code>.</p>
<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="fu"><a
href="https://rdrr.io/r/base/as.data.frame.html";
class="external-link">as.data.frame</a></span><span class="op">(</span><span
class="fu">read_nanoarrow</span><span class="op">(</span><span
class="fu">example_ipc_stream</span><span class="op">(</span><span
class="op">)</span><span class="op">)</span><span
class="op">)</span></span></span>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/as.data.frame.html";
class="external-link">as.data.frame</a></span><span class="op">(</span><span
class="fu">read_nanoarrow</span><span class="op">(</span><span class="fu"><a
href="example_ipc_stream.html">example_ipc_stream</a></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> some_col</span>
-<span class="r-out co"><span class="r-pr">#></span> 1 1</span>
-<span class="r-out co"><span class="r-pr">#></span> 2 2</span>
-<span class="r-out co"><span class="r-pr">#></span> 3 3</span>
+<span class="r-out co"><span class="r-pr">#></span> 1 0</span>
+<span class="r-out co"><span class="r-pr">#></span> 2 1</span>
+<span class="r-out co"><span class="r-pr">#></span> 3 2</span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
diff --git a/main/r/search.json b/main/r/search.json
index 3311bd14..35c44d04 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 c32c16f8..9eb3df20 100644
--- a/main/r/sitemap.xml
+++ b/main/r/sitemap.xml
@@ -13,6 +13,7 @@
<url><loc>/reference/basic_array_stream.html</loc></url>
<url><loc>/reference/convert_array.html</loc></url>
<url><loc>/reference/convert_array_stream.html</loc></url>
+<url><loc>/reference/example_ipc_stream.html</loc></url>
<url><loc>/reference/index.html</loc></url>
<url><loc>/reference/infer_nanoarrow_ptype.html</loc></url>
<url><loc>/reference/infer_nanoarrow_ptype_extension.html</loc></url>
