You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2019/03/18 21:50:43 UTC
[arrow] branch master updated: ARROW-3824: [R] Add basic build and
test documentation
This is an automated email from the ASF dual-hosted git repository.
wesm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 7a495e7 ARROW-3824: [R] Add basic build and test documentation
7a495e7 is described below
commit 7a495e7800ed2f184da1d5ffc4efde7d6c4abcac
Author: François Saint-Jacques <fs...@gmail.com>
AuthorDate: Mon Mar 18 16:47:59 2019 -0500
ARROW-3824: [R] Add basic build and test documentation
Author: François Saint-Jacques <fs...@gmail.com>
Closes #3967 from fsaintjacques/ARROW-3824-R-build-test-documentation and squashes the following commits:
8ea595b1f <François Saint-Jacques> ARROW-3824: Add basic build and test documentation
---
r/README.Rmd | 33 ++++++++++++++++++++--
r/README.md | 90 ++++++++++++++++++++++++++++++++++++++++--------------------
2 files changed, 91 insertions(+), 32 deletions(-)
diff --git a/r/README.Rmd b/r/README.Rmd
index ad566d9..b5365c2 100644
--- a/r/README.Rmd
+++ b/r/README.Rmd
@@ -18,13 +18,13 @@ knitr::opts_chunk$set(
R integration with Apache Arrow.
-## Installation
+## Installation
You first need to install the C++ library:
-### macOS
+### macOS
-On macOS, you may install using homebrew:
+On macOS, you may install using homebrew:
```
brew install apache-arrow
@@ -45,7 +45,10 @@ make install
## Then the R package
+### From github (defaults to master branch)
+
```r
+library("devtools")
devtools::install_github("apache/arrow/r")
```
@@ -61,3 +64,27 @@ tab
as_tibble(tab)
```
+## Developing
+
+The arrow package is using devtools for package related manipulations. To install:
+
+```r
+library.packages("devtools")
+```
+
+Within a local clone, one can test changes by running the test suite.
+
+### Running the test suite
+
+```r
+library("devtools")
+devtools::install_dev_deps()
+devtools::test()
+```
+
+### Full package validation
+
+```shell
+R CMD build --keep-empty-dirs .
+R CMD check arrow_*.tar.gz --as-cran --no-manual
+```
diff --git a/r/README.md b/r/README.md
index 79c40fc..79fa301 100644
--- a/r/README.md
+++ b/r/README.md
@@ -1,13 +1,14 @@
<!-- README.md is generated from README.Rmd. Please edit that file -->
-
-# arrow
+arrow
+=====
[](https://anaconda.org/conda-forge/r-arrow)
R integration with Apache Arrow.
-## Installation
+Installation
+------------
You first need to install the C++ library:
@@ -30,13 +31,18 @@ cmake .. -DARROW_PARQUET=ON -DCMAKE_BUILD_TYPE=Release -DARROW_BOOST_USE_SHARED:
make install
```
-## Then the R package
+Then the R package
+------------------
+
+### From github (defaults to master branch)
``` r
+library("devtools")
devtools::install_github("apache/arrow/r")
```
-## Example
+Example
+-------
``` r
library(arrow)
@@ -51,18 +57,18 @@ library(arrow)
(tib <- tibble::tibble(x = 1:10, y = rnorm(10)))
#> # A tibble: 10 x 2
-#> x y
-#> <int> <dbl>
-#> 1 1 0.585
-#> 2 2 0.378
-#> 3 3 0.958
-#> 4 4 -0.321
-#> 5 5 0.702
-#> 6 6 0.188
-#> 7 7 -0.625
-#> 8 8 -2.34
-#> 9 9 -0.0325
-#> 10 10 -1.22
+#> x y
+#> <int> <dbl>
+#> 1 1 -1.59
+#> 2 2 1.31
+#> 3 3 -0.513
+#> 4 4 2.64
+#> 5 5 0.389
+#> 6 6 0.660
+#> 7 7 1.66
+#> 8 8 -0.120
+#> 9 9 2.43
+#> 10 10 1.53
tab <- table(tib)
tab$schema
#> arrow::Schema
@@ -72,16 +78,42 @@ tab
#> arrow::Table
as_tibble(tab)
#> # A tibble: 10 x 2
-#> x y
-#> <int> <dbl>
-#> 1 1 0.585
-#> 2 2 0.378
-#> 3 3 0.958
-#> 4 4 -0.321
-#> 5 5 0.702
-#> 6 6 0.188
-#> 7 7 -0.625
-#> 8 8 -2.34
-#> 9 9 -0.0325
-#> 10 10 -1.22
+#> x y
+#> <int> <dbl>
+#> 1 1 -1.59
+#> 2 2 1.31
+#> 3 3 -0.513
+#> 4 4 2.64
+#> 5 5 0.389
+#> 6 6 0.660
+#> 7 7 1.66
+#> 8 8 -0.120
+#> 9 9 2.43
+#> 10 10 1.53
+```
+
+Developing
+----------
+
+The arrow package is using devtools for package related manipulations. To install:
+
+``` r
+library.packages("devtools")
+```
+
+Within a local clone, one can test changes by running the test suite.
+
+### Running the test suite
+
+``` r
+library("devtools")
+devtools::install_dev_deps()
+devtools::test()
+```
+
+### Full package validation
+
+``` shell
+R CMD build --keep-empty-dirs .
+R CMD check arrow_*.tar.gz --as-cran --no-manual
```