Repository navigation
Expand file tree
/
Copy path_pkgdown.yml
More file actions
375 lines (348 loc) · 9.89 KB
/
Copy path_pkgdown.yml
File metadata and controls
375 lines (348 loc) · 9.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# NPR: uncomment this to build docs for release
# destination: ../../arrow-site/asf-site/docs/r/
url: https://arrow.apache.org/docs/r/
title: Arrow R Package
template:
bootstrap: 5
bootswatch: cosmo
bslib:
font_scale: 1.1
includes:
in_header: |
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
/* We explicitly disable cookie tracking to avoid privacy issues */
_paq.push(['disableCookies']);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '20']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code -->
<!-- Kapa AI -->
<script
async
src="https://widget.kapa.ai/kapa-widget.bundle.js"
data-website-id="9db461d5-ac77-4b3f-a5c5-75efa78339d2"
data-project-name="Apache Arrow"
data-project-color="#000000"
data-project-logo="https://arrow.apache.org/img/arrow-logo_chevrons_white-txt_black-bg.png"
data-modal-disclaimer="This is a custom LLM with access to all of [Arrow documentation](https://arrow.apache.org/docs/). If you want an R-specific answer, please mention this in your question."
data-consent-required="true"
data-user-analytics-cookie-enabled="false"
data-consent-screen-disclaimer="By clicking "I agree, let's chat", you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."
></script>
<!-- End Kapa AI -->
opengraph:
image:
src: https://arrow.apache.org/img/arrow-logo_horizontal_black-txt_white-bg.png
alt: "Apache Arrow logo, displaying the triple chevron image adjacent to the text"
home:
title: Arrow R Package
sidebar:
structure:
- project
- links
- license
- community
- implementations
- citation
- authors
- dev
components:
project:
title: Arrow Project
text: >
[Homepage](https://arrow.apache.org/) <br>
[Specifications](https://arrow.apache.org/docs/format/Columnar.html)
implementations:
title: Implementations
text: >
[.NET](https://arrow.apache.org/dotnet/) <br>
[C GLib](https://arrow.apache.org/docs/c_glib) <br>
[C++](https://arrow.apache.org/docs/cpp) <br>
[Go](https://arrow.apache.org/go/) <br>
[JavaScript](https://arrow.apache.org/js/) <br>
[Java](https://arrow.apache.org/docs/java) <br>
[Julia](https://github.com/apache/arrow-julia/blob/main/README.md) <br>
[MATLAB](https://github.com/apache/arrow/blob/main/matlab/README.md) <br>
[Python](https://arrow.apache.org/docs/python) <br>
[R](index.html) <br>
[Ruby](https://github.com/apache/arrow/blob/main/ruby/README.md) <br>
[Rust](https://docs.rs/crate/arrow/latest) <br>
[Swift](https://arrow.apache.org/swift/)
community:
title: Community
text: >
[Code of conduct](https://www.apache.org/foundation/policies/conduct.html)
navbar:
bg: black
structure:
left:
- home
- intro
- reference
- articles
- news
- project
right: github
components:
reference:
text: Reference
href: reference/index.html
articles:
- title: Using the package
navbar: Using the package
contents:
- read_write
- data_wrangling
- dataset
- python
- fs
- flight
- title: Arrow concepts
navbar: Arrow concepts
contents:
- data_objects
- data_types
- metadata
- title: Installation
navbar: Installation
contents:
- install
- install_nightly
- title: Developer guides
contents:
- developing
- developers/setup
- developers/workflow
- developers/debugging
- developers/docker
- developers/install_details
- developers/data_object_layout
- developers/binary_features
reference:
- title: Read datasets
desc: >
Open multi-file datasets as Arrow Dataset objects.
contents:
- open_dataset
- open_delim_dataset
- open_csv_dataset
- open_tsv_dataset
- csv_read_options
- csv_parse_options
- csv_convert_options
- title: Write datasets
desc: >
Write multi-file datasets to disk.
contents:
- write_dataset
- write_delim_dataset
- write_csv_dataset
- write_tsv_dataset
- csv_write_options
- title: Read files
desc: >
Read files in a variety of formats in as tibbles or Arrow Tables.
contents:
- read_delim_arrow
- read_parquet
- read_feather
- read_ipc_file
- read_ipc_stream
- read_json_arrow
- title: Write files
desc: >
Write to files in a variety of formats.
contents:
- write_csv_arrow
- write_parquet
- write_feather
- write_ipc_file
- write_ipc_stream
- write_to_raw
- title: Creating Arrow data containers
desc: >
Classes and functions for creating Arrow data containers.
contents:
- scalar
- arrow_array
- chunked_array
- record_batch
- arrow_table
- buffer
- vctrs_extension_array
- title: Working with Arrow data containers
desc: >
Functions for converting R objects to Arrow data containers and combining Arrow data containers.
contents:
- as_arrow_array
- as_chunked_array
- as_record_batch
- as_arrow_table
- concat_arrays
- concat_tables
- title: Arrow data types
contents:
- data-type
- dictionary
- new_extension_type
- vctrs_extension_type
- as_data_type
- infer_type
- title: Fields and schemas
contents:
- field
- schema
- unify_schemas
- as_schema
- infer_schema
- read_schema
- title: Computation
desc: >
Functionality for computing values on Arrow data objects.
contents:
- acero
- add_filename
- cast
- arrow-functions
- arrow-verbs
- arrow-dplyr
- call_function
- match_arrow
- value_counts
- list_compute_functions
- register_scalar_function
- show_exec_plan
- title: DuckDB
desc: >
Pass data to and from DuckDB
contents:
- to_arrow
- to_duckdb
- title: File systems
desc: >
Functions for working with files on S3, GCS, and Azure
contents:
- s3_bucket
- gs_bucket
- az_container
- copy_files
- title: Flight
contents:
- load_flight_server
- flight_connect
- flight_disconnect
- flight_get
- flight_put
- list_flights
- title: Arrow Configuration
contents:
- arrow_info
- cpu_count
- io_thread_count
- install_arrow
- install_pyarrow
- create_package_with_all_dependencies
- title: Input/Output
contents:
- InputStream
- read_message
- mmap_open
- mmap_create
- OutputStream
- Message
- MessageReader
- compression
- Codec
- codec_is_available
- title: File read/writer interface
contents:
- ParquetFileReader
- ParquetReaderProperties
- ParquetArrowReaderProperties
- ParquetFileWriter
- ParquetWriterProperties
- FeatherReader
- CsvTableReader
- CsvReadOptions
- CsvWriteOptions
- RecordBatchReader
- RecordBatchWriter
- as_record_batch_reader
- title: Low-level C++ wrappers
desc: >
Low-level R6 class representations of Arrow C++ objects intended for advanced users.
contents:
- Buffer
- Scalar
- Array
- ChunkedArray
- RecordBatch
- Schema
- Field
- Table
- DataType
- ArrayData
- DictionaryType
- FixedWidthType
- ExtensionType
- ArrayData
- ExtensionArray
- title: Dataset and Filesystem R6 classes and helper functions
desc: >
R6 classes and helper functions useful for when working with multi-file datases in Arrow.
contents:
- Dataset
- dataset_factory
- Partitioning
- Expression
- Scanner
- FileFormat
- CsvFileFormat
- JsonFileFormat
- FileWriteOptions
- FragmentScanOptions
- hive_partition
- map_batches
- FileSystem
- FileInfo
- FileSelector
repo:
url:
home: https://github.com/apache/arrow/
source: https://github.com/apache/arrow/blob/main/r/
issue: https://github.com/apache/arrow/issues/
user: https://github.com/
footer:
structure:
left: older_versions
right: [built_with, legal]
components:
older_versions: "[Older versions of these docs](https://arrow.apache.org/docs/r/versions.html)"
legal: |
<small>Apache Arrow, Arrow, Apache, the Apache logo, and the Apache Arrow project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</small>