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 b96264c update documentation for tag dev
b96264c is described below
commit b96264cb6af8fe24bfb905092719cfd39db3b7b8
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Feb 7 19:42:17 2023 +0000
update documentation for tag dev
---
dev/r/pkgdown.yml | 2 +-
dev/r/reference/as_nanoarrow_array.html | 4 +-
dev/r/reference/as_nanoarrow_array_stream.html | 4 +-
dev/r/reference/as_nanoarrow_schema.html | 16 +-
dev/r/reference/index.html | 7 +-
dev/r/reference/na_type.html | 304 +++++++++++++++++++++++++
dev/r/search.json | 2 +-
dev/r/sitemap.xml | 3 +
8 files changed, 332 insertions(+), 10 deletions(-)
diff --git a/dev/r/pkgdown.yml b/dev/r/pkgdown.yml
index 2fd49d8..46df979 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-02T17:54Z
+last_built: 2023-02-07T19:42Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index a397fd9..8b81a43 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 0x55f1b55d1358></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5556332d95f8></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 0x55f1b51b2428></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5556330c1578></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 e98425a..1720b62 100644
--- a/dev/r/reference/as_nanoarrow_array_stream.html
+++ b/dev/r/reference/as_nanoarrow_array_stream.html
@@ -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> .. ..$ name :
chr "x"</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ metadata :
list()</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ flags :
int 2</span>
-<span class="r-out co"><span class="r-pr">#></span> .. ..$ children :
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> $ dictionary:
NULL</span>
<span class="r-in"><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>
@@ -134,7 +134,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 0x55f1aff95398></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55563358fb18></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_schema.html
b/dev/r/reference/as_nanoarrow_schema.html
index f67a19f..1ad9ee6 100644
--- a/dev/r/reference/as_nanoarrow_schema.html
+++ b/dev/r/reference/as_nanoarrow_schema.html
@@ -64,7 +64,9 @@ are represented identically.</p>
<span></span>
<span><span class="fu">infer_nanoarrow_schema</span><span
class="op">(</span><span class="va">x</span>, <span class="va">...</span><span
class="op">)</span></span>
<span></span>
-<span><span class="fu">nanoarrow_schema_parse</span><span
class="op">(</span><span class="va">x</span>, recursive <span
class="op">=</span> <span class="cn">FALSE</span><span
class="op">)</span></span></code></pre></div>
+<span><span class="fu">nanoarrow_schema_parse</span><span
class="op">(</span><span class="va">x</span>, recursive <span
class="op">=</span> <span class="cn">FALSE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">nanoarrow_schema_modify</span><span
class="op">(</span><span class="va">x</span>, <span
class="va">new_values</span>, validate <span class="op">=</span> <span
class="cn">TRUE</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
@@ -81,6 +83,14 @@ are represented identically.</p>
<dd><p>Use <code>TRUE</code> to include a <code>children</code> member when
parsing
schemas.</p></dd>
+
+<dt>new_values</dt>
+<dd><p>New schema component to assign</p></dd>
+
+
+<dt>validate</dt>
+<dd><p>Use <code>FALSE</code> to skip schema validation</p></dd>
+
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
@@ -97,7 +107,7 @@ schemas.</p></dd>
<span class="r-out co"><span class="r-pr">#></span> $ name : chr
""</span>
<span class="r-out co"><span class="r-pr">#></span> $ metadata :
list()</span>
<span class="r-out co"><span class="r-pr">#></span> $ flags : int
2</span>
-<span class="r-out co"><span class="r-pr">#></span> $ children :
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-in"><span><span class="fu">infer_nanoarrow_schema</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="fu"><a
href="https://rdrr.io/r/base/integer.html";
class="external-link">integer</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> <nanoarrow_schema
struct></span>
@@ -111,7 +121,7 @@ schemas.</p></dd>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ name :
chr "x"</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ metadata :
list()</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ flags :
int 2</span>
-<span class="r-out co"><span class="r-pr">#></span> .. ..$ children :
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> $ dictionary:
NULL</span>
<span class="r-in"><span></span></span>
diff --git a/dev/r/reference/index.html b/dev/r/reference/index.html
index a64772f..3908efc 100644
--- a/dev/r/reference/index.html
+++ b/dev/r/reference/index.html
@@ -63,7 +63,7 @@
<dd>Convert an object to a nanoarrow array_stream</dd>
</dl><dl><dt>
- <code><a
href="as_nanoarrow_schema.html">as_nanoarrow_schema()</a></code> <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schema()</a></code> <code><a
href="as_nanoarrow_schema.html">nanoarrow_schema_parse()</a></code>
+ <code><a
href="as_nanoarrow_schema.html">as_nanoarrow_schema()</a></code> <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schema()</a></code> <code><a
href="as_nanoarrow_schema.html">nanoarrow_schema_parse()</a></code> <code><a
href="as_nanoarrow_schema.html">nanoarrow_schema_modify()</a></code>
</dt>
<dd>Convert an object to a nanoarrow schema</dd>
</dl><dl><dt>
@@ -88,6 +88,11 @@
<dd>Infer an R vector prototype</dd>
</dl><dl><dt>
+ <code><a href="na_type.html">na_type()</a></code> <code><a
href="na_type.html">na_na()</a></code> <code><a
href="na_type.html">na_bool()</a></code> <code><a
href="na_type.html">na_int8()</a></code> <code><a
href="na_type.html">na_uint8()</a></code> <code><a
href="na_type.html">na_int16()</a></code> <code><a
href="na_type.html">na_uint16()</a></code> <code><a
href="na_type.html">na_int32()</a></code> <code><a
href="na_type.html">na_uint32()</a></code> <code><a href="na_type.html [...]
+ </dt>
+ <dd>Create type objects</dd>
+ </dl><dl><dt>
+
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_is_valid()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_dbl()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_chr()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_pretty()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_release()</a></code>
<code><a href="nanoarrow_pointer_is_vali [...]
</dt>
<dd>Danger zone: low-level pointer operations</dd>
diff --git a/dev/r/reference/na_type.html b/dev/r/reference/na_type.html
new file mode 100644
index 0000000..2a7b12d
--- /dev/null
+++ b/dev/r/reference/na_type.html
@@ -0,0 +1,304 @@
+<!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="In nanoarow, types, fields,
and schemas are all represented by a
+nanoarrow_schema. These functions are convenience
+constructors to create these objects in a readable way. Use na_type() to
+construct types based on the constructor name, which is also the name that
+prints/is returned by nanoarrow_schema_parse()."><title>Create type objects —
na_type • 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.2.2/bootstrap.min.css" rel="stylesheet"><script
src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font
Awesome icons --><link rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs [...]
+nanoarrow_schema. These functions are convenience
+constructors to create these objects in a readable way. Use na_type() to
+construct types based on the constructor name, which is also the name that
+prints/is returned by nanoarrow_schema_parse()."><!-- 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"><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.0.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>
+ </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>Create type objects</h1>
+ <small class="dont-index">Source: <a
href="https://github.com/apache/arrow-nanoarrow/blob/HEAD/R/type.R";
class="external-link"><code>R/type.R</code></a></small>
+ <div class="d-none name"><code>na_type.Rd</code></div>
+ </div>
+
+ <div class="ref-description section level2">
+ <p>In nanoarow, types, fields, and schemas are all represented by a
+<a href="as_nanoarrow_schema.html">nanoarrow_schema</a>. These functions are
convenience
+constructors to create these objects in a readable way. Use
<code>na_type()</code> to
+construct types based on the constructor name, which is also the name that
+prints/is returned by <code><a
href="as_nanoarrow_schema.html">nanoarrow_schema_parse()</a></code>.</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">na_type</span><span class="op">(</span></span>
+<span> <span class="va">type_name</span>,</span>
+<span> byte_width <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> unit <span class="op">=</span> <span class="cn">NULL</span>,</span>
+<span> timezone <span class="op">=</span> <span class="cn">NULL</span>,</span>
+<span> column_types <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> item_type <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> key_type <span class="op">=</span> <span class="cn">NULL</span>,</span>
+<span> value_type <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> index_type <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> ordered <span class="op">=</span> <span class="cn">NULL</span>,</span>
+<span> list_size <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> keys_sorted <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> storage_type <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> extension_name <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> extension_metadata <span class="op">=</span> <span
class="cn">NULL</span>,</span>
+<span> nullable <span class="op">=</span> <span class="cn">NULL</span></span>
+<span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_na</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_bool</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_int8</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_uint8</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_int16</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_uint16</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_int32</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_uint32</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_int64</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_uint64</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_half_float</span><span class="op">(</span>nullable
<span class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_float</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_double</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_string</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_large_string</span><span class="op">(</span>nullable
<span class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_binary</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_large_binary</span><span class="op">(</span>nullable
<span class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_fixed_size_binary</span><span
class="op">(</span><span class="va">byte_width</span>, nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_date32</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_date64</span><span class="op">(</span>nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_time32</span><span class="op">(</span>unit <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">"ms"</span>, <span class="st">"s"</span><span class="op">)</span>,
nullable <span class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_time64</span><span class="op">(</span>unit <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">"ns"</span>, <span class="st">"us"</span><span class="op">)</span>,
nullable <span class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_duration</span><span class="op">(</span>unit <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">"ms"</span>, <span class="st">"s"</span>, <span
class="st">"us"</span>, <span class="st">"ns"</span><span class="op">)</span>,
nullable <span class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_interval_months</span><span
class="op">(</span>nullable <span class="op">=</span> <span
class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_interval_day_time</span><span
class="op">(</span>nullable <span class="op">=</span> <span
class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_interval_month_day_nano</span><span
class="op">(</span>nullable <span class="op">=</span> <span
class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_timestamp</span><span class="op">(</span>unit <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">"ms"</span>, <span class="st">"s"</span>, <span
class="st">"us"</span>, <span class="st">"ns"</span><span class="op">)</span>,
timezone <span class="op">=</span> <span class="st">""</span>, nullable <span
class="op">=</span> <span class="cn">TRUE</span><span cl [...]
+<span></span>
+<span><span class="fu">na_decimal128</span><span class="op">(</span><span
class="va">precision</span>, <span class="va">scale</span>, nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_decimal256</span><span class="op">(</span><span
class="va">precision</span>, <span class="va">scale</span>, nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_struct</span><span class="op">(</span>column_types
<span class="op">=</span> <span class="fu"><a
href="https://rdrr.io/r/base/list.html";
class="external-link">list</a></span><span class="op">(</span><span
class="op">)</span>, nullable <span class="op">=</span> <span
class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_sparse_union</span><span
class="op">(</span>column_types <span class="op">=</span> <span class="fu"><a
href="https://rdrr.io/r/base/list.html";
class="external-link">list</a></span><span class="op">(</span><span
class="op">)</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_dense_union</span><span
class="op">(</span>column_types <span class="op">=</span> <span class="fu"><a
href="https://rdrr.io/r/base/list.html";
class="external-link">list</a></span><span class="op">(</span><span
class="op">)</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_list</span><span class="op">(</span><span
class="va">item_type</span>, nullable <span class="op">=</span> <span
class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_large_list</span><span class="op">(</span><span
class="va">item_type</span>, nullable <span class="op">=</span> <span
class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_fixed_size_list</span><span class="op">(</span><span
class="va">item_type</span>, <span class="va">list_size</span>, nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_map</span><span class="op">(</span><span
class="va">key_type</span>, <span class="va">item_type</span>, keys_sorted
<span class="op">=</span> <span class="cn">FALSE</span>, nullable <span
class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_dictionary</span><span class="op">(</span><span
class="va">value_type</span>, index_type <span class="op">=</span> <span
class="fu">na_int32</span><span class="op">(</span><span class="op">)</span>,
ordered <span class="op">=</span> <span class="cn">FALSE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">na_extension</span><span class="op">(</span><span
class="va">storage_type</span>, <span class="va">extension_name</span>,
extension_metadata <span class="op">=</span> <span class="st">""</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>type_name</dt>
+<dd><p>The name of the type (e.g., "int32"). This form of the
+constructor is useful for writing tests that loop over many types.</p></dd>
+
+
+<dt>byte_width</dt>
+<dd><p>For <code>na_fixed_size_binary()</code>, the number of bytes
+occupied by each item.</p></dd>
+
+
+<dt>unit</dt>
+<dd><p>One of 's' (seconds), 'ms' (milliseconds), 'us' (microseconds),
+or 'ns' (nanoseconds).</p></dd>
+
+
+<dt>timezone</dt>
+<dd><p>A string representing a timezone name. The empty string ""
+represents a naive point in time (i.e., one that has no associated
+timezone).</p></dd>
+
+
+<dt>column_types</dt>
+<dd><p>A <code><a href="https://rdrr.io/r/base/list.html";
class="external-link">list()</a></code> of <a
href="as_nanoarrow_schema.html">nanoarrow_schema</a>s.</p></dd>
+
+
+<dt>item_type</dt>
+<dd><p>For <code>na_list()</code>, <code>na_large_list()</code>,
<code>na_fixed_size_list()</code>,
+and <code>na_map()</code>, the <a
href="as_nanoarrow_schema.html">nanoarrow_schema</a> representing
+the item type.</p></dd>
+
+
+<dt>key_type</dt>
+<dd><p>The <a href="as_nanoarrow_schema.html">nanoarrow_schema</a>
representing the
+<code>na_map()</code> key type.</p></dd>
+
+
+<dt>value_type</dt>
+<dd><p>The <a href="as_nanoarrow_schema.html">nanoarrow_schema</a>
representing the
+<code>na_dictionary()</code> or <code>na_map()</code> value type.</p></dd>
+
+
+<dt>index_type</dt>
+<dd><p>The <a href="as_nanoarrow_schema.html">nanoarrow_schema</a>
representing the
+<code>na_dictionary()</code> index type.</p></dd>
+
+
+<dt>ordered</dt>
+<dd><p>Use <code>TRUE</code> to assert that the order of values in the
+dictionary are meaningful.</p></dd>
+
+
+<dt>list_size</dt>
+<dd><p>The number of elements in each item in a
+<code>na_fixed_size_list()</code>.</p></dd>
+
+
+<dt>keys_sorted</dt>
+<dd><p>Use <code>TRUE</code> to assert that keys are sorted.</p></dd>
+
+
+<dt>storage_type</dt>
+<dd><p>For <code>na_extension()</code>, the underlying value type.</p></dd>
+
+
+<dt>extension_name</dt>
+<dd><p>For <code>na_extension()</code>, the extension name. This is
+typically namespaced separated by dots (e.g., arrow.r.vctrs).</p></dd>
+
+
+<dt>extension_metadata</dt>
+<dd><p>A string or raw vector defining extension metadata.
+Most Arrow extension types define extension metadata as a JSON object.</p></dd>
+
+
+<dt>nullable</dt>
+<dd><p>Use <code>FALSE</code> to assert that this field cannot contain
+null values.</p></dd>
+
+
+<dt>precision</dt>
+<dd><p>The total number of digits representable by the decimal type</p></dd>
+
+
+<dt>scale</dt>
+<dd><p>The number of digits after the decimal point in a decimal type</p></dd>
+
+</dl></div>
+ <div class="section level2">
+ <h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
+
+
+<p>A <a href="as_nanoarrow_schema.html">nanoarrow_schema</a></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">na_int32</span><span
class="op">(</span><span class="op">)</span></span></span>
+<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_schema
int32></span>
+<span class="r-out co"><span class="r-pr">#></span> $ format : chr
"i"</span>
+<span class="r-out co"><span class="r-pr">#></span> $ name : chr
""</span>
+<span class="r-out co"><span class="r-pr">#></span> $ metadata :
list()</span>
+<span class="r-out co"><span class="r-pr">#></span> $ flags : int
2</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-in"><span><span class="fu">na_struct</span><span
class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/list.html";
class="external-link">list</a></span><span class="op">(</span>col1 <span
class="op">=</span> <span class="fu">na_int32</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> <nanoarrow_schema
struct></span>
+<span class="r-out co"><span class="r-pr">#></span> $ format : chr
"+s"</span>
+<span class="r-out co"><span class="r-pr">#></span> $ name : chr
""</span>
+<span class="r-out co"><span class="r-pr">#></span> $ metadata :
list()</span>
+<span class="r-out co"><span class="r-pr">#></span> $ flags : int
2</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> ..$
col1:<nanoarrow_schema int32></span>
+<span class="r-out co"><span class="r-pr">#></span> .. ..$ format :
chr "i"</span>
+<span class="r-out co"><span class="r-pr">#></span> .. ..$ name :
chr "col1"</span>
+<span class="r-out co"><span class="r-pr">#></span> .. ..$ metadata :
list()</span>
+<span class="r-out co"><span class="r-pr">#></span> .. ..$ flags :
int 2</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> $ dictionary:
NULL</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></p><p>Developed by Dewey Dunnington, Apache Arrow.</p>
+</div>
+
+<div class="pkgdown-footer-right">
+ <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/";
class="external-link">pkgdown</a> 2.0.7.</p>
+</div>
+
+ </footer></div>
+
+
+
+
+
+ </body></html>
+
diff --git a/dev/r/search.json b/dev/r/search.json
index b379194..ea48b35 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 [...]
diff --git a/dev/r/sitemap.xml b/dev/r/sitemap.xml
index fb32932..17b6953 100644
--- a/dev/r/sitemap.xml
+++ b/dev/r/sitemap.xml
@@ -36,6 +36,9 @@
<url>
<loc>/reference/infer_nanoarrow_ptype.html</loc>
</url>
+ <url>
+ <loc>/reference/na_type.html</loc>
+ </url>
<url>
<loc>/reference/nanoarrow-package.html</loc>
</url>
