summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/_pkgdown.yml
blob: c6a19119ed304c01e6ddc3b04e29c891a377366f (plain)
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
# 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:
  params:
    bootswatch: cosmo
    ganalytics: UA-107500873-1
navbar:
  structure:
    left:
      - home
      - intro
      - reference
      - articles
      - news
      - project
    right: github
  components:
    home:
      text: ❯❯❯
      href: https://arrow.apache.org/
    reference:
      text: Reference
      href: reference/index.html
    project:
      text: Project docs
      menu:
        - text: Specification
          href: https://arrow.apache.org/docs/format/README.html
        - text: C GLib
          href: https://arrow.apache.org/docs/c_glib
        - text: C++
          href: https://arrow.apache.org/docs/cpp
        - text: Java
          href: https://arrow.apache.org/docs/java
        - text: JavaScript
          href: https://arrow.apache.org/docs/js
        - text: Python
          href: https://arrow.apache.org/docs/python
        - text: R
          href: index.html
    articles:
      text: Articles
      menu:
        - text: Installing the Arrow Package on Linux
          href: articles/install.html
        - text: Working with Arrow Datasets and dplyr
          href: articles/dataset.html
        - text: Working with Cloud Storage (S3)
          href: articles/fs.html
        - text: Apache Arrow in Python and R with reticulate
          href: articles/python.html
        - text: Connecting to Flight RPC Servers
          href: articles/flight.html
        - text: Arrow R Developer Guide
          href: articles/developing.html
reference:
  - title: Multi-file datasets
    contents:
      - open_dataset
      - write_dataset
      - dataset_factory
      - hive_partition
      - Dataset
      - Partitioning
      - Expression
      - Scanner
      - FileFormat
      - FileWriteOptions
      - FragmentScanOptions
      - map_batches
  - title: Reading and writing files
    contents:
      - read_feather
      - read_ipc_stream
      - read_parquet
      - read_delim_arrow
      - read_json_arrow
      - write_feather
      - write_ipc_stream
      - write_to_raw
      - write_parquet
      - write_csv_arrow
  - title: C++ reader/writer interface
    contents:
      - ParquetFileReader
      - ParquetArrowReaderProperties
      - ParquetFileWriter
      - ParquetWriterProperties
      - FeatherReader
      - CsvTableReader
      - RecordBatchReader
      - RecordBatchWriter
      - CsvReadOptions
      - CsvWriteOptions
  - title: Arrow data containers
    contents:
      - array
      - ChunkedArray
      - Scalar
      - RecordBatch
      - Table
      - ArrayData
      - buffer
      - read_message
  - title: Arrow data types and schema
    contents:
      - Schema
      - unify_schemas
      - type
      - dictionary
      - Field
      - read_schema
      - data-type
      - DataType
      - DictionaryType
      - FixedWidthType
  - title: Flight
    contents:
      - load_flight_server
      - flight_connect
      - flight_get
      - flight_put
      - list_flights
  - title: File systems
    contents:
      - s3_bucket
      - FileSystem
      - FileInfo
      - FileSelector
      - copy_files
  - title: Input/Output
    contents:
      - InputStream
      - mmap_open
      - mmap_create
      - OutputStream
      - Message
      - MessageReader
      - compression
      - Codec
      - codec_is_available
  - title: Computation
    contents:
      - call_function
      - match_arrow
      - value_counts
      - list_compute_functions
  - title: Connections to other systems
    contents:
      - to_arrow
      - to_duckdb
  - title: Configuration
    contents:
      - arrow_info
      - cpu_count
      - io_thread_count
      - arrow_available
      - install_arrow
      - install_pyarrow
      - create_package_with_all_dependencies

repo:
  jira_projects: [ARROW]
  url:
    source: https://github.com/apache/arrow/blob/master/r/
    issue: https://issues.apache.org/jira/browse/