ceph/src/arrow/r/STYLE.md

   1 <!---
   2   Licensed to the Apache Software Foundation (ASF) under one
   3   or more contributor license agreements.  See the NOTICE file
   4   distributed with this work for additional information
   5   regarding copyright ownership.  The ASF licenses this file
   6   to you under the Apache License, Version 2.0 (the
   7   "License"); you may not use this file except in compliance
   8   with the License.  You may obtain a copy of the License at
   9
  10     http://www.apache.org/licenses/LICENSE-2.0
  11
  12   Unless required by applicable law or agreed to in writing,
  13   software distributed under the License is distributed on an
  14   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15   KIND, either express or implied.  See the License for the
  16   specific language governing permissions and limitations
  17   under the License.
  18 -->
  19
  20 # Style
  21
  22 This is a style guide to writing documentation for arrow.
  23
  24 ## Coding style
  25
  26 Please use the [tidyverse coding style](https://style.tidyverse.org/).
  27
  28 ## Referring to external packages
  29
  30 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.
  31
  32 * "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."
  33
  34 ## Data frames
  35
  36 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.
  37
  38 * "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."