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 bc357ec update documentation for tag main
bc357ec is described below
commit bc357ecd09be1932e34a884927adae5da916985b
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Aug 23 17:26:01 2023 +0000
update documentation for tag main
---
main/r/pkgdown.yml | 2 +-
main/r/reference/convert_array.html | 9 +++++--
main/r/reference/convert_array_stream.html | 41 +++++++++++++++++++++++++++---
main/r/reference/index.html | 2 +-
main/r/search.json | 2 +-
5 files changed, 48 insertions(+), 8 deletions(-)
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 826a85c..5326a05 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-08-18T18:40Z
+last_built: 2023-08-23T17:25Z
diff --git a/main/r/reference/convert_array.html
b/main/r/reference/convert_array.html
index 2f4863e..e6eb21a 100644
--- a/main/r/reference/convert_array.html
+++ b/main/r/reference/convert_array.html
@@ -103,6 +103,12 @@ through a floating-point double (e.g., very large uint64
and int64 values).</p><
<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
@@ -117,8 +123,7 @@ converted to <code><a
href="https://vctrs.r-lib.org/reference/list_of.html"; clas
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; dictionary-encoded arrays are not
-currently supported.</p>
+converted as their storage type.</p>
</div>
<div class="section level2">
diff --git a/main/r/reference/convert_array_stream.html
b/main/r/reference/convert_array_stream.html
index d8056ef..45aec16 100644
--- a/main/r/reference/convert_array_stream.html
+++ b/main/r/reference/convert_array_stream.html
@@ -63,7 +63,9 @@ default inferences of <code>to</code>.</p>
<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_stream</span><span class="op">(</span><span
class="va">array_stream</span>, to <span class="op">=</span> <span
class="cn">NULL</span>, size <span class="op">=</span> <span
class="cn">NULL</span>, n <span class="op">=</span> <span
class="cn">Inf</span><span class="op">)</span></span></code></pre></div>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span
class="fu">convert_array_stream</span><span class="op">(</span><span
class="va">array_stream</span>, to <span class="op">=</span> <span
class="cn">NULL</span>, size <span class="op">=</span> <span
class="cn">NULL</span>, n <span class="op">=</span> <span
class="cn">Inf</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">collect_array_stream</span><span
class="op">(</span><span class="va">array_stream</span>, n <span
class="op">=</span> <span class="cn">Inf</span>, schema <span
class="op">=</span> <span class="cn">NULL</span>, validate <span
class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
@@ -88,13 +90,24 @@ slightly more efficient implementation may be used to
collect the output.</p></d
<dt>n</dt>
<dd><p>The maximum number of batches to pull from the array stream.</p></dd>
+
+<dt>schema</dt>
+<dd><p>A <a href="as_nanoarrow_schema.html">nanoarrow_schema</a> or
<code>NULL</code> to guess
+based on the first schema.</p></dd>
+
+
+<dt>validate</dt>
+<dd><p>Use <code>FALSE</code> to skip the validation step (i.e., if you
+know that the arrays are valid).</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>
+<ul><li><p><code>convert_array_stream()</code>: An R vector of type
<code>to</code>.</p></li>
+<li><p><code>collect_array_stream()</code>: A <code><a
href="https://rdrr.io/r/base/list.html"; class="external-link">list()</a></code>
of <a href="as_nanoarrow_array.html">nanoarrow_array</a></p></li>
+</ul></div>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
@@ -106,6 +119,28 @@ slightly more efficient implementation may be used to
collect the output.</p></d
<span class="r-out co"><span class="r-pr">#></span> 'data.frame': 0 obs.
of 1 variable:</span>
<span class="r-out co"><span class="r-pr">#></span> $ x: num </span>
<span class="r-in"><span></span></span>
+<span class="r-in"><span><span class="va">stream</span> <span
class="op"><-</span> <span class="fu"><a
href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream</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 class="r-in"><span><span class="fu">collect_array_stream</span><span
class="op">(</span><span class="va">stream</span><span
class="op">)</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_array
struct[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
1</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<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>
+<span class="r-out co"><span class="r-pr">#></span> </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>
diff --git a/main/r/reference/index.html b/main/r/reference/index.html
index fb78858..e1b7cad 100644
--- a/main/r/reference/index.html
+++ b/main/r/reference/index.html
@@ -91,7 +91,7 @@
<dd>Convert an Array into an R vector</dd>
</dl><dl><dt>
- <code><a
href="convert_array_stream.html">convert_array_stream()</a></code>
+ <code><a
href="convert_array_stream.html">convert_array_stream()</a></code> <code><a
href="convert_array_stream.html">collect_array_stream()</a></code>
</dt>
<dd>Convert an Array Stream into an R vector</dd>
</dl><dl><dt>
diff --git a/main/r/search.json b/main/r/search.json
index 05ccfa9..51e3635 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":"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 [...]
