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 b46fd67 update documentation for tag dev
b46fd67 is described below
commit b46fd6789f2cff61f592401be4a9c14a8744d2a7
Author: GitHub Actions <[email protected]>
AuthorDate: Wed May 31 00:04:34 2023 +0000
update documentation for tag dev
---
dev/r/pkgdown.yml | 2 +-
dev/r/reference/as_nanoarrow_array.html | 10 +++++-----
dev/r/reference/as_nanoarrow_array_stream.html | 6 +++---
dev/r/reference/as_nanoarrow_buffer.html | 25 +++++++++++++++----------
dev/r/reference/index.html | 2 +-
dev/r/reference/nanoarrow_array_init.html | 6 +++---
dev/r/reference/nanoarrow_buffer_init.html | 12 +++++++++++-
dev/r/search.json | 2 +-
8 files changed, 40 insertions(+), 25 deletions(-)
diff --git a/dev/r/pkgdown.yml b/dev/r/pkgdown.yml
index 727b50f..c6e72a3 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-05-30T12:51Z
+last_built: 2023-05-31T00:04Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 549c982..a7db239 100644
--- a/dev/r/reference/as_nanoarrow_array.html
+++ b/dev/r/reference/as_nanoarrow_array.html
@@ -96,8 +96,8 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<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[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55c77f7041c8></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-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>
@@ -109,15 +109,15 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<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[0 b] at (nil)></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[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55c7802893c8></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>
diff --git a/dev/r/reference/as_nanoarrow_array_stream.html
b/dev/r/reference/as_nanoarrow_array_stream.html
index 4788264..6e8a631 100644
--- a/dev/r/reference/as_nanoarrow_array_stream.html
+++ b/dev/r/reference/as_nanoarrow_array_stream.html
@@ -125,15 +125,15 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<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[0 b] at (nil)></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[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55c7818c2228></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>
diff --git a/dev/r/reference/as_nanoarrow_buffer.html
b/dev/r/reference/as_nanoarrow_buffer.html
index dbad022..c05505b 100644
--- a/dev/r/reference/as_nanoarrow_buffer.html
+++ b/dev/r/reference/as_nanoarrow_buffer.html
@@ -70,17 +70,22 @@
<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">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 0x55c7800e6be8></span>
+ <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/c.html";
class="external-link">c</a></span><span class="op">(</span><span
class="cn">NA</span>, <span class="fl">1</span><span class="op">:</span><span
class="fl">4</span><span class="op">)</spa [...]
+<span class="r-in"><span><span class="va">array</span><span
class="op">$</span><span class="va">buffers</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_buffer
validity<bool>[8][1 b]> `FALSE TRUE TRUE TRUE TRUE TRUE TR...`</span>
+<span class="r-out co"><span class="r-pr">#></span> </span>
+<span class="r-out co"><span class="r-pr">#></span> [[2]]</span>
+<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_buffer
data<int32>[5][20 b]> `NA 1 2 3 4`</span>
+<span class="r-out co"><span class="r-pr">#></span> </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">1</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] fe</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 0x55c7800fa728></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>
+<span class="r-out co"><span class="r-pr">#></span> [1] 00 00 00 80 01 00
00 00 02 00 00 00 03 00 00 00 04 00 00 00</span>
+<span class="r-in"><span><span class="fu"><a
href="nanoarrow_buffer_init.html">convert_buffer</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">1</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] FALSE TRUE TRUE
TRUE TRUE TRUE TRUE TRUE</span>
+<span class="r-in"><span><span class="fu"><a
href="nanoarrow_buffer_init.html">convert_buffer</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] NA 1 2 3
4</span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
diff --git a/dev/r/reference/index.html b/dev/r/reference/index.html
index b1d6a71..12ce474 100644
--- a/dev/r/reference/index.html
+++ b/dev/r/reference/index.html
@@ -108,7 +108,7 @@
<dd>Modify nanoarrow arrays</dd>
</dl><dl><dt>
- <code><a
href="nanoarrow_buffer_init.html">nanoarrow_buffer_init()</a></code> <code><a
href="nanoarrow_buffer_init.html">nanoarrow_buffer_append()</a></code>
+ <code><a
href="nanoarrow_buffer_init.html">nanoarrow_buffer_init()</a></code> <code><a
href="nanoarrow_buffer_init.html">nanoarrow_buffer_append()</a></code> <code><a
href="nanoarrow_buffer_init.html">convert_buffer()</a></code>
</dt>
<dd>Create and modify nanoarrow buffers</dd>
</dl><dl><dt>
diff --git a/dev/r/reference/nanoarrow_array_init.html
b/dev/r/reference/nanoarrow_array_init.html
index 32fca5b..0716481 100644
--- a/dev/r/reference/nanoarrow_array_init.html
+++ b/dev/r/reference/nanoarrow_array_init.html
@@ -116,9 +116,9 @@ modified parameters such that the original array remains
valid.</p></li>
<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
3</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_offset32[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_utf8[0 b] at (nil)></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_offset<int32>[0][0 b]> ``</span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer data<string>[0 b]> ``</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></span>
diff --git a/dev/r/reference/nanoarrow_buffer_init.html
b/dev/r/reference/nanoarrow_buffer_init.html
index fb4ad0d..65f59a3 100644
--- a/dev/r/reference/nanoarrow_buffer_init.html
+++ b/dev/r/reference/nanoarrow_buffer_init.html
@@ -50,7 +50,9 @@
<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_buffer_init</span><span class="op">(</span><span
class="op">)</span></span>
<span></span>
-<span><span class="fu">nanoarrow_buffer_append</span><span
class="op">(</span><span class="va">buffer</span>, <span
class="va">new_buffer</span><span class="op">)</span></span></code></pre></div>
+<span><span class="fu">nanoarrow_buffer_append</span><span
class="op">(</span><span class="va">buffer</span>, <span
class="va">new_buffer</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">convert_buffer</span><span class="op">(</span><span
class="va">buffer</span>, to <span class="op">=</span> <span
class="cn">NULL</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
@@ -58,6 +60,14 @@
<dl><dt>buffer, new_buffer</dt>
<dd><p><a href="as_nanoarrow_buffer.html">nanoarrow_buffer</a>s.</p></dd>
+
+<dt>to</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>
+
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
diff --git a/dev/r/search.json b/dev/r/search.json
index 7f8843a..cef743a 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":"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 1 9 [...]
+[{"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":"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 1 9 [...]
