Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
9929e55
Remove backticks to make easier to read
thisisnic Jul 21, 2021
fbe7466
Grammarly suggestions and adding some subheadings
thisisnic Jul 21, 2021
9726952
"we" -> "you"
thisisnic Jul 21, 2021
e13543d
Use bold instead of backticks to make package names more readable
thisisnic Jul 21, 2021
a941444
Split paragraph into bullets
thisisnic Jul 21, 2021
02ffc4c
Breaking sections down and tweaks
thisisnic Jul 21, 2021
ae9b685
Rename section heading
thisisnic Jul 21, 2021
2c4f9f4
Specify Windows version for S3, minor tweaks
thisisnic Jul 21, 2021
52ec5f6
Update r/vignettes/dataset.Rmd
thisisnic Jul 21, 2021
254771f
Remove highlighting of arrow/dplyr to make easier to read and more li…
thisisnic Jul 26, 2021
ff09054
Remove extra backticks on Arrow object names
thisisnic Jul 26, 2021
4ee3b42
Remove unnecessary "Arrow"
thisisnic Jul 26, 2021
9df7b5c
Remove unnecessary hyphens
thisisnic Jul 26, 2021
5cb9469
"a" -> "an"
thisisnic Jul 29, 2021
40860cf
Make explanation more explicit
thisisnic Jul 29, 2021
df69b6d
Stylistic change
thisisnic Jul 29, 2021
5c415c3
Add STYLE.md
thisisnic Jul 29, 2021
f8ab48a
Update style file to make clearer
thisisnic Jul 29, 2021
c7052f9
Explicitly reference supported parsing options
thisisnic Jul 30, 2021
f065df2
Tweak STYLE.md and its examples
thisisnic Jul 30, 2021
c150bbc
Use headings
thisisnic Jul 30, 2021
88b63ae
"for" -> "to"
thisisnic Jul 30, 2021
b5f75b7
Pedantry
thisisnic Jul 30, 2021
1bb3c88
add ASF header
thisisnic Aug 3, 2021
be3e7bb
Delete sentence
thisisnic Aug 3, 2021
5c5b60a
Merge branch 'master' into ARROW_13399_dataset_vignette
thisisnic Aug 3, 2021
feed3b5
Update .Rbuildignore
thisisnic Aug 3, 2021
6666c13
Update r/STYLE.md
thisisnic Aug 4, 2021
0cde04f
Update r/vignettes/dataset.Rmd
thisisnic Aug 4, 2021
9873808
Update r/vignettes/dataset.Rmd
thisisnic Aug 4, 2021
52a66f8
Update r/vignettes/dataset.Rmd
thisisnic Aug 4, 2021
1a4ff1d
Update r/vignettes/dataset.Rmd
thisisnic Aug 4, 2021
8ba084c
Update r/vignettes/dataset.Rmd
thisisnic Aug 4, 2021
b4ea47b
Update r/vignettes/dataset.Rmd
thisisnic Aug 4, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions r/.Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ clang_format.sh
^apache-arrow.rb$
^.*\.Rhistory$
^extra-tests
STYLE.md
^.lintr
38 changes: 38 additions & 0 deletions r/STYLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!---
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.
-->

# Style

This is a style guide to writing documentation for arrow.

## Coding style

Please use the [tidyverse coding style](https://style.tidyverse.org/).

## Referring to external packages

When referring to external packages, include a link to the package at the first mention, and subsequently refer to it in plain text, e.g.

* "The arrow R package provides a [dplyr](https://dplyr.tidyverse.org/) interface to Arrow Datasets. This vignette introduces Datasets and shows how to use dplyr to analyze them."

## Data frames

When referring to the concept, use the phrase "data frame", whereas when referring to an object of that class or when the class is important, write `data.frame`, e.g.

* "You can call `write_dataset()` on tabular data objects such as Arrow Tables or RecordBatches, or R data frames. If working with data frames you might want to use a `tibble` instead of a `data.frame` to take advantage of the default behaviour of partitioning data based on grouped variables."
Loading