From 8a018ab6834930018dd78df4fce5a4e59a3eb352 Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Mon, 16 Aug 2021 17:21:40 +0100 Subject: [PATCH 1/8] Make styling match up with description in STYLE.html, add more links, add link to dataset.Rmd vignette --- r/vignettes/flight.Rmd | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/r/vignettes/flight.Rmd b/r/vignettes/flight.Rmd index 9ca10d7f303..76a0d1d0dc5 100644 --- a/r/vignettes/flight.Rmd +++ b/r/vignettes/flight.Rmd @@ -11,14 +11,17 @@ vignette: > is a general-purpose client-server framework for high performance transport of large datasets over network interfaces, built as part of the [Apache Arrow](https://arrow.apache.org) project. -The `arrow` package provides methods for connecting to Flight RPC servers + +The arrow package provides methods for connecting to Flight RPC servers to send and receive data. ## Getting Started -The `flight` functions in the package use `reticulate` to call methods in the -`pyarrow` Python package. Before using them for the first time, -you'll need to be sure you have `reticulate`, and you'll also need to +The `flight` functions in the package use [reticulate](https://rstudio.github.io/reticulate/) to call methods in the +[pyarrow](https://arrow.apache.org/docs/python/api/flight.html) Python package. + +Before using them for the first time, +you'll need to be sure you have reticulate, and you'll also need to install `pyarrow`: ```r @@ -75,4 +78,5 @@ client %>% ``` Because `flight_get()` returns an Arrow data structure, we can directly pipe -its result into a `dplyr` workflow. +its result into a [dplyr](https://dplyr.tidyverse.org/) workflow. +See [the dataset vignette](./dataset.html) for more information on working with Arrow Dataset objects and via a dplyr interface. From 4650bfeb6f7129d781f5c6f53d665f2f048fd790 Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Tue, 17 Aug 2021 11:10:13 +0100 Subject: [PATCH 2/8] Extra whitespace to trigger build --- r/tools/nixlibs.R | 1 + 1 file changed, 1 insertion(+) diff --git a/r/tools/nixlibs.R b/r/tools/nixlibs.R index cd0838395bf..0bd8de39bca 100644 --- a/r/tools/nixlibs.R +++ b/r/tools/nixlibs.R @@ -519,3 +519,4 @@ if (!file.exists(paste0(dst_dir, "/include/arrow/api.h"))) { cat("*** Proceeding without C++ dependencies\n") } } + From 5cbc8c89174b1b4de15f11a43ed2757651167432 Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Tue, 17 Aug 2021 13:21:37 +0100 Subject: [PATCH 3/8] Add a sentence about why Flight is awesome --- r/vignettes/flight.Rmd | 2 ++ 1 file changed, 2 insertions(+) diff --git a/r/vignettes/flight.Rmd b/r/vignettes/flight.Rmd index 76a0d1d0dc5..bd8bfa13ebd 100644 --- a/r/vignettes/flight.Rmd +++ b/r/vignettes/flight.Rmd @@ -12,6 +12,8 @@ is a general-purpose client-server framework for high performance transport of large datasets over network interfaces, built as part of the [Apache Arrow](https://arrow.apache.org) project. +Flight allows for highly efficient data transfer as it removes the need for deserialization during data transfer, allows for parallel data streaming, and is highly optimized to take advantage of Arrow's columnar format. + The arrow package provides methods for connecting to Flight RPC servers to send and receive data. From c5333ac73f5a54d5dc6c97d0e8d63f256502d377 Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Tue, 17 Aug 2021 13:26:21 +0100 Subject: [PATCH 4/8] Remove backticks around pyarrow for consistency --- r/vignettes/flight.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/r/vignettes/flight.Rmd b/r/vignettes/flight.Rmd index bd8bfa13ebd..719c77f9697 100644 --- a/r/vignettes/flight.Rmd +++ b/r/vignettes/flight.Rmd @@ -24,7 +24,7 @@ The `flight` functions in the package use [reticulate](https://rstudio.github.io Before using them for the first time, you'll need to be sure you have reticulate, and you'll also need to -install `pyarrow`: +install pyarrow: ```r install.packages("reticulate") From 2405cec252b6030b6628968f373e75c1323bc4f4 Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Tue, 17 Aug 2021 13:28:49 +0100 Subject: [PATCH 5/8] Rephrase for simplicity --- r/vignettes/flight.Rmd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/r/vignettes/flight.Rmd b/r/vignettes/flight.Rmd index 719c77f9697..819028f084d 100644 --- a/r/vignettes/flight.Rmd +++ b/r/vignettes/flight.Rmd @@ -79,6 +79,6 @@ client %>% ## 3 virginica 6.9 ``` -Because `flight_get()` returns an Arrow data structure, we can directly pipe +Because `flight_get()` returns an Arrow data structure, you can directly pipe its result into a [dplyr](https://dplyr.tidyverse.org/) workflow. -See [the dataset vignette](./dataset.html) for more information on working with Arrow Dataset objects and via a dplyr interface. +See [the dataset vignette](./dataset.html) for more information on working with Arrow objects via a dplyr interface. From 952bf3a62cb30fe711c41a219318329829bcf835 Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Tue, 17 Aug 2021 13:29:52 +0100 Subject: [PATCH 6/8] Simplify wording --- r/vignettes/flight.Rmd | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/r/vignettes/flight.Rmd b/r/vignettes/flight.Rmd index 819028f084d..58632a16c9d 100644 --- a/r/vignettes/flight.Rmd +++ b/r/vignettes/flight.Rmd @@ -23,8 +23,7 @@ The `flight` functions in the package use [reticulate](https://rstudio.github.io [pyarrow](https://arrow.apache.org/docs/python/api/flight.html) Python package. Before using them for the first time, -you'll need to be sure you have reticulate, and you'll also need to -install pyarrow: +you'll need to be sure you have reticulate and pyarrow installed: ```r install.packages("reticulate") From 92b1b93b52f793923fc410bb58c49f6c04cc14d8 Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Tue, 17 Aug 2021 13:31:38 +0100 Subject: [PATCH 7/8] Bullet points --- r/vignettes/flight.Rmd | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/r/vignettes/flight.Rmd b/r/vignettes/flight.Rmd index 58632a16c9d..809e3a5be51 100644 --- a/r/vignettes/flight.Rmd +++ b/r/vignettes/flight.Rmd @@ -12,7 +12,11 @@ is a general-purpose client-server framework for high performance transport of large datasets over network interfaces, built as part of the [Apache Arrow](https://arrow.apache.org) project. -Flight allows for highly efficient data transfer as it removes the need for deserialization during data transfer, allows for parallel data streaming, and is highly optimized to take advantage of Arrow's columnar format. +Flight allows for highly efficient data transfer as it: + +* removes the need for deserialization during data transfer +* allows for parallel data streaming +* is highly optimized to take advantage of Arrow's columnar format. The arrow package provides methods for connecting to Flight RPC servers to send and receive data. From 3dea1982cb892c50915fc603a163b5fb908002fe Mon Sep 17 00:00:00 2001 From: Nic Date: Wed, 25 Aug 2021 08:19:41 +0000 Subject: [PATCH 8/8] Update r/vignettes/flight.Rmd Co-authored-by: Neal Richardson --- r/vignettes/flight.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/r/vignettes/flight.Rmd b/r/vignettes/flight.Rmd index 809e3a5be51..e8af5cad6f7 100644 --- a/r/vignettes/flight.Rmd +++ b/r/vignettes/flight.Rmd @@ -84,4 +84,4 @@ client %>% Because `flight_get()` returns an Arrow data structure, you can directly pipe its result into a [dplyr](https://dplyr.tidyverse.org/) workflow. -See [the dataset vignette](./dataset.html) for more information on working with Arrow objects via a dplyr interface. +See `vignette("dataset", package = "arrow")` for more information on working with Arrow objects via a dplyr interface.