This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 43b5643 update documentation for tag dev
43b5643 is described below
commit 43b56432cdc046b6f7e40f301bf80ac8ae30e698
Author: GitHub Actions <[email protected]>
AuthorDate: Thu Feb 16 20:51:43 2023 +0000
update documentation for tag dev
---
dev/r/index.html | 85 ++++++++++++++++---------
dev/r/pkgdown.yml | 2 +-
dev/r/reference/as_nanoarrow_array.html | 4 +-
dev/r/reference/as_nanoarrow_array_stream.html | 2 +-
dev/r/reference/as_nanoarrow_buffer.html | 4 +-
dev/r/reference/nanoarrow-package.html | 4 +-
dev/r/reference/nanoarrow_pointer_is_valid.html | 19 ++++++
dev/r/search.json | 2 +-
8 files changed, 84 insertions(+), 38 deletions(-)
diff --git a/dev/r/index.html b/dev/r/index.html
index 21d10de..3b70f87 100644
--- a/dev/r/index.html
+++ b/dev/r/index.html
@@ -76,12 +76,15 @@
<div class="section level2">
<h2 id="installation">Installation<a class="anchor" aria-label="anchor"
href="#installation"></a>
</h2>
-<p>You can install the development version of nanoarrow from <a
href="https://github.com/" class="external-link">GitHub</a> with:</p>
+<p>You can install the released version of nanoarrow from <a
href="https://cran.r-project.org/" class="external-link">CRAN</a> with:</p>
<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a
href="https://rdrr.io/r/utils/install.packages.html"
class="external-link">install.packages</a></span><span class="op">(</span><span
class="st">"nanoarrow"</span><span class="op">)</span></span></code></pre></div>
+<p>You can install the development version of nanoarrow from <a
href="https://github.com/" class="external-link">GitHub</a> with:</p>
+<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="co">#
install.packages("remotes")</span></span>
<span><span class="fu">remotes</span><span class="fu">::</span><span
class="fu">install_github</span><span class="op">(</span><span
class="st">"apache/arrow-nanoarrow/r"</span><span
class="op">)</span></span></code></pre></div>
<p>If you can load the package, you’re good to go!</p>
-<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
+<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="kw"><a
href="https://rdrr.io/r/base/library.html"
class="external-link">library</a></span><span class="op">(</span><span
class="va"><a href="https://github.com/apache/arrow-nanoarrow"
class="external-link">nanoarrow</a></span><span
class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
@@ -91,15 +94,15 @@
<div class="section level3">
<h3 id="schemas">Schemas<a class="anchor" aria-label="anchor"
href="#schemas"></a>
</h3>
-<p>Use <code><a
href="reference/as_nanoarrow_schema.html">infer_nanoarrow_schema()</a></code>
to get the ArrowSchema object that corresponds to a given R vector type; use
<code><a
href="reference/as_nanoarrow_schema.html">as_nanoarrow_schema()</a></code> to
convert an object from some other data type representation (e.g., an arrow R
package <code>DataType</code> like <code><a
href="https://arrow.apache.org/docs/r/reference/data-type.html"
class="external-link">arrow::int32()</a></code>).</p>
-<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
+<p>Use <code><a
href="reference/as_nanoarrow_schema.html">infer_nanoarrow_schema()</a></code>
to get the ArrowSchema object that corresponds to a given R vector type; use
<code><a
href="reference/as_nanoarrow_schema.html">as_nanoarrow_schema()</a></code> to
convert an object from some other data type representation (e.g., an arrow R
package <code>DataType</code> like <code><a
href="https://arrow.apache.org/docs/r/reference/data-type.html"
class="external-link">arrow::int32()</a></code>); [...]
+<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu"><a
href="reference/as_nanoarrow_schema.html">infer_nanoarrow_schema</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="co">#> <nanoarrow_schema int32></span></span>
<span><span class="co">#> $ format : chr "i"</span></span>
<span><span class="co">#> $ name : chr ""</span></span>
<span><span class="co">#> $ metadata : list()</span></span>
<span><span class="co">#> $ flags : int 2</span></span>
-<span><span class="co">#> $ children : NULL</span></span>
+<span><span class="co">#> $ children : list()</span></span>
<span><span class="co">#> $ dictionary: NULL</span></span>
<span><span class="fu"><a
href="reference/as_nanoarrow_schema.html">as_nanoarrow_schema</a></span><span
class="op">(</span><span class="fu">arrow</span><span class="fu">::</span><span
class="fu"><a href="https://arrow.apache.org/docs/r/reference/Schema.html"
class="external-link">schema</a></span><span class="op">(</span>col1 <span
class="op">=</span> <span class="fu">arrow</span><span
class="fu">::</span><span class="fu"><a
href="https://arrow.apache.org/docs/r/reference/data-type.html" [...]
<span><span class="co">#> <nanoarrow_schema struct></span></span>
@@ -113,15 +116,23 @@
<span><span class="co">#> .. ..$ name : chr "col1"</span></span>
<span><span class="co">#> .. ..$ metadata : list()</span></span>
<span><span class="co">#> .. ..$ flags : int 2</span></span>
-<span><span class="co">#> .. ..$ children : NULL</span></span>
+<span><span class="co">#> .. ..$ children : list()</span></span>
<span><span class="co">#> .. ..$ dictionary: NULL</span></span>
+<span><span class="co">#> $ dictionary: NULL</span></span>
+<span><span class="fu"><a
href="reference/na_type.html">na_int64</a></span><span class="op">(</span><span
class="op">)</span></span>
+<span><span class="co">#> <nanoarrow_schema int64></span></span>
+<span><span class="co">#> $ format : chr "l"</span></span>
+<span><span class="co">#> $ name : chr ""</span></span>
+<span><span class="co">#> $ metadata : list()</span></span>
+<span><span class="co">#> $ flags : int 2</span></span>
+<span><span class="co">#> $ children : list()</span></span>
<span><span class="co">#> $ dictionary:
NULL</span></span></code></pre></div>
</div>
<div class="section level3">
<h3 id="arrays">Arrays<a class="anchor" aria-label="anchor" href="#arrays"></a>
</h3>
<p>Use <code><a
href="reference/as_nanoarrow_array.html">as_nanoarrow_array()</a></code> to
convert an object to an ArrowArray object:</p>
-<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
+<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu"><a
href="reference/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="co">#> <nanoarrow_array int32[5]></span></span>
<span><span class="co">#> $ length : int 5</span></span>
@@ -129,10 +140,10 @@
<span><span class="co">#> $ offset : int 0</span></span>
<span><span class="co">#> $ buffers :List of 2</span></span>
<span><span class="co">#> ..$ :<nanoarrow_buffer_validity[0 b] at
0x0></span></span>
-<span><span class="co">#> ..$ :<nanoarrow_buffer_data_int32[20 b] at
0x10d316a68></span></span>
+<span><span class="co">#> ..$ :<nanoarrow_buffer_data_int32[20 b] at
0x14e4bd638></span></span>
<span><span class="co">#> $ dictionary: NULL</span></span>
<span><span class="co">#> $ children : list()</span></span>
-<span><span class="fu"><a
href="reference/as_nanoarrow_array.html">as_nanoarrow_array</a></span><span
class="op">(</span><span class="fu">arrow</span><span class="fu">::</span><span
class="fu"><a href="https://arrow.apache.org/docs/r/reference/RecordBatch.html"
class="external-link">record_batch</a></span><span class="op">(</span>col1
<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=" [...]
+<span><span class="fu"><a
href="reference/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>col1 <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="fl">1.1</span>, <span class="fl">2.2</span><span
class="op">)</span><span cla [...]
<span><span class="co">#> <nanoarrow_array struct[2]></span></span>
<span><span class="co">#> $ length : int 2</span></span>
<span><span class="co">#> $ null_count: int 0</span></span>
@@ -146,19 +157,19 @@
<span><span class="co">#> .. ..$ offset : int 0</span></span>
<span><span class="co">#> .. ..$ buffers :List of 2</span></span>
<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_validity[0 b]
at 0x0></span></span>
-<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_data_double[16
b] at 0x11e534bb8></span></span>
+<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_data_double[16
b] at 0x14e62ccb8></span></span>
<span><span class="co">#> .. ..$ dictionary: NULL</span></span>
<span><span class="co">#> .. ..$ children : list()</span></span>
<span><span class="co">#> $ dictionary:
NULL</span></span></code></pre></div>
<p>You can use <code><a href="https://rdrr.io/r/base/vector.html"
class="external-link">as.vector()</a></code> or <code><a
href="https://rdrr.io/r/base/as.data.frame.html"
class="external-link">as.data.frame()</a></code> to get the R representation of
the object back:</p>
-<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
-<code class="sourceCode R"><span><span class="va">array</span> <span
class="op"><-</span> <span class="fu"><a
href="reference/as_nanoarrow_array.html">as_nanoarrow_array</a></span><span
class="op">(</span><span class="fu">arrow</span><span class="fu">::</span><span
class="fu"><a href="https://arrow.apache.org/docs/r/reference/RecordBatch.html"
class="external-link">record_batch</a></span><span class="op">(</span>col1
<span class="op">=</span> <span class="fu"><a href="https://rdrr.io/ [...]
+<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">array</span> <span
class="op"><-</span> <span class="fu"><a
href="reference/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>col1 <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><sp [...]
<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="va">array</span><span class="op">)</span></span>
<span><span class="co">#> col1</span></span>
<span><span class="co">#> 1 1.1</span></span>
<span><span class="co">#> 2 2.2</span></span></code></pre></div>
<p>Even though at the C level the ArrowArray is distinct from the ArrowSchema,
at the R level we attach a schema wherever possible. You can access the
attached schema using <code><a
href="reference/as_nanoarrow_schema.html">infer_nanoarrow_schema()</a></code>:</p>
-<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
+<div class="sourceCode" id="cb7"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu"><a
href="reference/as_nanoarrow_schema.html">infer_nanoarrow_schema</a></span><span
class="op">(</span><span class="va">array</span><span
class="op">)</span></span>
<span><span class="co">#> <nanoarrow_schema struct></span></span>
<span><span class="co">#> $ format : chr "+s"</span></span>
@@ -171,27 +182,23 @@
<span><span class="co">#> .. ..$ name : chr "col1"</span></span>
<span><span class="co">#> .. ..$ metadata : list()</span></span>
<span><span class="co">#> .. ..$ flags : int 2</span></span>
-<span><span class="co">#> .. ..$ children : NULL</span></span>
+<span><span class="co">#> .. ..$ children : list()</span></span>
<span><span class="co">#> .. ..$ dictionary: NULL</span></span>
<span><span class="co">#> $ dictionary:
NULL</span></span></code></pre></div>
</div>
<div class="section level3">
<h3 id="array-streams">Array Streams<a class="anchor" aria-label="anchor"
href="#array-streams"></a>
</h3>
-<p>The easiest way to create an ArrowArrayStream is from an <code><a
href="https://arrow.apache.org/docs/r/reference/RecordBatchReader.html"
class="external-link">arrow::RecordBatchReader</a></code>:</p>
-<div class="sourceCode" id="cb7"><pre class="downlit sourceCode r">
-<code class="sourceCode R"><span><span class="va">reader</span> <span
class="op"><-</span> <span class="fu">arrow</span><span
class="fu">::</span><span class="va"><a
href="https://arrow.apache.org/docs/r/reference/RecordBatchReader.html"
class="external-link">RecordBatchReader</a></span><span
class="op">$</span><span class="fu">create</span><span
class="op">(</span></span>
-<span> <span class="fu">arrow</span><span class="fu">::</span><span
class="fu"><a href="https://arrow.apache.org/docs/r/reference/RecordBatch.html"
class="external-link">record_batch</a></span><span class="op">(</span>col1
<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="fl">1.1</span>, <span
class="fl">2.2</span><span class="op">)</span><span class="op">)</span>,</span>
-<span> <span class="fu">arrow</span><span class="fu">::</span><span
class="fu"><a href="https://arrow.apache.org/docs/r/reference/RecordBatch.html"
class="external-link">record_batch</a></span><span class="op">(</span>col1
<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="fl">3.3</span>, <span
class="fl">4.4</span><span class="op">)</span><span class="op">)</span></span>
-<span><span class="op">)</span></span>
-<span></span>
-<span><span class="op">(</span><span class="va">stream</span> <span
class="op"><-</span> <span class="fu"><a
href="reference/as_nanoarrow_array_stream.html">as_nanoarrow_array_stream</a></span><span
class="op">(</span><span class="va">reader</span><span
class="op">)</span><span class="op">)</span></span>
-<span><span class="co">#> <nanoarrow_array_stream struct<col1:
double>></span></span>
-<span><span class="co">#> $ get_schema:function () </span></span>
-<span><span class="co">#> $ get_next :function (schema = x$get_schema(),
validate = TRUE) </span></span>
-<span><span class="co">#> $ release :function
()</span></span></code></pre></div>
-<p>You can pull batches from the stream using the <code>$get_next()</code>
method. The last batch will return <code>NULL</code>.</p>
+<p>The easiest way to create an ArrowArrayStream is from a list of arrays or
objects that can be converted to an array using <code><a
href="reference/as_nanoarrow_array.html">as_nanoarrow_array()</a></code>:</p>
<div class="sourceCode" id="cb8"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">stream</span> <span
class="op"><-</span> <span class="fu"><a
href="reference/basic_array_stream.html">basic_array_stream</a></span><span
class="op">(</span></span>
+<span> <span class="fu"><a href="https://rdrr.io/r/base/list.html"
class="external-link">list</a></span><span class="op">(</span></span>
+<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>col1 <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="fl">1.1</span>, <span class="fl">2.2</span><span
class="op">)</span><span class="op">)</span>,</span>
+<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>col1 <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="fl">3.3</span>, <span class="fl">4.4</span><span
class="op">)</span><span class="op">)</span></span>
+<span> <span class="op">)</span></span>
+<span><span class="op">)</span></span></code></pre></div>
+<p>You can pull batches from the stream using the <code>$get_next()</code>
method. The last batch will return <code>NULL</code>.</p>
+<div class="sourceCode" id="cb9"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="va">stream</span><span
class="op">$</span><span class="fu">get_next</span><span
class="op">(</span><span class="op">)</span></span>
<span><span class="co">#> <nanoarrow_array struct[2]></span></span>
<span><span class="co">#> $ length : int 2</span></span>
@@ -206,7 +213,7 @@
<span><span class="co">#> .. ..$ offset : int 0</span></span>
<span><span class="co">#> .. ..$ buffers :List of 2</span></span>
<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_validity[0 b]
at 0x0></span></span>
-<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_data_double[16
b] at 0x119c35838></span></span>
+<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_data_double[16
b] at 0x13af88b38></span></span>
<span><span class="co">#> .. ..$ dictionary: NULL</span></span>
<span><span class="co">#> .. ..$ children : list()</span></span>
<span><span class="co">#> $ dictionary: NULL</span></span>
@@ -224,15 +231,35 @@
<span><span class="co">#> .. ..$ offset : int 0</span></span>
<span><span class="co">#> .. ..$ buffers :List of 2</span></span>
<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_validity[0 b]
at 0x0></span></span>
-<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_data_double[16
b] at 0x119c710b8></span></span>
+<span><span class="co">#> .. .. ..$ :<nanoarrow_buffer_data_double[16
b] at 0x13af886f8></span></span>
<span><span class="co">#> .. ..$ dictionary: NULL</span></span>
<span><span class="co">#> .. ..$ children : list()</span></span>
<span><span class="co">#> $ dictionary: NULL</span></span>
<span><span class="va">stream</span><span class="op">$</span><span
class="fu">get_next</span><span class="op">(</span><span
class="op">)</span></span>
<span><span class="co">#> NULL</span></span></code></pre></div>
+<p>You can pull all the batches into a <code><a
href="https://rdrr.io/r/base/data.frame.html"
class="external-link">data.frame()</a></code> by calling <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>:</p>
+<div class="sourceCode" id="cb10"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">stream</span> <span
class="op"><-</span> <span class="fu"><a
href="reference/basic_array_stream.html">basic_array_stream</a></span><span
class="op">(</span></span>
+<span> <span class="fu"><a href="https://rdrr.io/r/base/list.html"
class="external-link">list</a></span><span class="op">(</span></span>
+<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>col1 <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="fl">1.1</span>, <span class="fl">2.2</span><span
class="op">)</span><span class="op">)</span>,</span>
+<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>col1 <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="fl">3.3</span>, <span class="fl">4.4</span><span
class="op">)</span><span class="op">)</span></span>
+<span> <span class="op">)</span></span>
+<span><span class="op">)</span></span>
+<span></span>
+<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="va">stream</span><span class="op">)</span></span>
+<span><span class="co">#> col1</span></span>
+<span><span class="co">#> 1 1.1</span></span>
+<span><span class="co">#> 2 2.2</span></span>
+<span><span class="co">#> 3 3.3</span></span>
+<span><span class="co">#> 4 4.4</span></span></code></pre></div>
<p>After consuming a stream, you should call the release method as soon as you
can. This lets the implementation of the stream release any resources (like
open files) it may be holding in a more predictable way than waiting for the
garbage collector to clean up the object.</p>
</div>
</div>
+<div class="section level2">
+<h2 id="integration-with-the-arrow-package">Integration with the arrow
package<a class="anchor" aria-label="anchor"
href="#integration-with-the-arrow-package"></a>
+</h2>
+<p>The nanoarrow package implements <code><a
href="reference/as_nanoarrow_schema.html">as_nanoarrow_schema()</a></code>,
<code><a
href="reference/as_nanoarrow_array.html">as_nanoarrow_array()</a></code>, and
<code><a
href="reference/as_nanoarrow_array_stream.html">as_nanoarrow_array_stream()</a></code>
for most arrow package types. Similarly, it implements <code><a
href="https://arrow.apache.org/docs/r/reference/as_arrow_array.html"
class="external-link">arrow::as_arrow_array()</a></code [...]
+</div>
</div>
</main><aside class="col-md-3"><div class="links">
<h2 data-toc-skip>Links</h2>
diff --git a/dev/r/pkgdown.yml b/dev/r/pkgdown.yml
index 8da8b41..1e46d95 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.19.2
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-02-15T21:08Z
+last_built: 2023-02-16T20:51Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index dcab9cc..6a00f66 100644
--- a/dev/r/reference/as_nanoarrow_array.html
+++ b/dev/r/reference/as_nanoarrow_array.html
@@ -97,7 +97,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<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[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x557c56f32958></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5562e4b12de8></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-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/vector.html"
class="external-link">as.vector</a></span><span class="op">(</span><span
class="va">array</span><span class="op">)</span></span></span>
@@ -117,7 +117,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<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[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x557c56fa32a8></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5562e5955f88></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>
diff --git a/dev/r/reference/as_nanoarrow_array_stream.html
b/dev/r/reference/as_nanoarrow_array_stream.html
index 953cd98..94e514b 100644
--- a/dev/r/reference/as_nanoarrow_array_stream.html
+++ b/dev/r/reference/as_nanoarrow_array_stream.html
@@ -133,7 +133,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<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[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x557c56fa2448></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5562e58ade98></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>
diff --git a/dev/r/reference/as_nanoarrow_buffer.html
b/dev/r/reference/as_nanoarrow_buffer.html
index ce39b8d..85428e3 100644
--- a/dev/r/reference/as_nanoarrow_buffer.html
+++ b/dev/r/reference/as_nanoarrow_buffer.html
@@ -72,12 +72,12 @@
<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">4</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">array</span><span
class="op">$</span><span class="va">buffers</span><span
class="op">[[</span><span class="fl">2</span><span class="op">]</span><span
class="op">]</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_buffer_data_int32[16 b] at 0x557c58820628></span>
+<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_buffer_data_int32[16 b] at 0x5562e774b628></span>
<span class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/raw.html"
class="external-link">as.raw</a></span><span class="op">(</span><span
class="va">array</span><span class="op">$</span><span
class="va">buffers</span><span class="op">[[</span><span
class="fl">2</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> [1] 01 00 00 00 02 00
00 00 03 00 00 00 04 00 00 00</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu">as_nanoarrow_buffer</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-out co"><span class="r-pr">#></span> <nanoarrow_buffer[20
b] at 0x557c5895d168></span>
+<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_buffer[20
b] at 0x5562e7a12198></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">buffer</span> <span
class="op"><-</span> <span class="fu">as_nanoarrow_buffer</span><span
class="op">(</span><span class="cn">NULL</span><span
class="op">)</span></span></span>
<span class="r-in"><span></span></span>
diff --git a/dev/r/reference/nanoarrow-package.html
b/dev/r/reference/nanoarrow-package.html
index 6b2e46a..cb8744f 100644
--- a/dev/r/reference/nanoarrow-package.html
+++ b/dev/r/reference/nanoarrow-package.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"><meta name="description" content="Provides an R interface to
the 'nanoarrow' C library and the 'Apache Arrow' application binary interface.
Functions to import and export 'ArrowArray', 'ArrowS [...]
+<!-- 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="Provides an 'R' interface
to the 'nanoarrow' C library and the 'Apache Arrow' application binary
interface. Functions to import and export 'ArrowArray', 'Arro [...]
<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>
@@ -43,7 +43,7 @@
</div>
<div class="ref-description section level2">
- <p>Provides an R interface to the 'nanoarrow' C library and the 'Apache
Arrow' application binary interface. Functions to import and export
'ArrowArray', 'ArrowSchema', and 'ArrowArrayStream' C structures to and from R
objects are provided alongside helpers to facilitate zero-copy data transfer
among R bindings to libraries implementing the 'Arrow' C data interface.</p>
+ <p>Provides an 'R' interface to the 'nanoarrow' C library and the 'Apache
Arrow' application binary interface. Functions to import and export
'ArrowArray', 'ArrowSchema', and 'ArrowArrayStream' C structures to and from
'R' objects are provided alongside helpers to facilitate zero-copy data
transfer among R bindings to libraries implementing the 'Arrow' C data
interface.</p>
</div>
diff --git a/dev/r/reference/nanoarrow_pointer_is_valid.html
b/dev/r/reference/nanoarrow_pointer_is_valid.html
index cbb0a88..1321df4 100644
--- a/dev/r/reference/nanoarrow_pointer_is_valid.html
+++ b/dev/r/reference/nanoarrow_pointer_is_valid.html
@@ -97,6 +97,25 @@ non-null.</p>
<code>struct ArrowArray</code>, or <code>struct
ArrowArrayStream</code>.</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>nanoarrow_pointer_is_valid()</code> returns TRUE if the
pointer is non-null
+and has a non-null release callback.</p></li>
+<li><p><code>nanoarrow_pointer_addr_dbl()</code> and
<code>nanoarrow_pointer_addr_chr()</code> return
+pointer representations that may be helpful to facilitate moving or
+exporting nanoarrow objects to other libraries.</p></li>
+<li><p><code>nanoarrow_pointer_addr_pretty()</code> gives a pointer
representation suitable
+for printing or error messages.</p></li>
+<li><p><code>nanoarrow_pointer_release()</code> returns <code>ptr</code>,
invisibly.</p></li>
+<li><p><code>nanoarrow_pointer_move()</code> and
<code>nanoarrow_pointer_export()</code> reeturn
+<code>ptr_dst</code>, invisibly.</p></li>
+<li><p><code>nanoarrow_allocate_array()</code>,
<code>nanoarrow_allocate_schema()</code>, and
+<code>nanoarrow_allocate_array_stream()</code> return an
+<a href="as_nanoarrow_array.html">array</a>, a <a
href="as_nanoarrow_schema.html">schema</a>, and an
+<a href="as_nanoarrow_array_stream.html">array stream</a>,
respectively.</p></li>
+</ul></div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor"
href="#details"></a></h2>
<p>When interacting with other C Data Interface implementations, it is
diff --git a/dev/r/search.json b/dev/r/search.json
index be79ab6..6f26b80 100644
--- a/dev/r/search.json
+++ b/dev/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 [...]