Skip to content

Commit 908b058

Browse files
nealrichardsonkou
authored andcommitted
ARROW-6142: [R] Install instructions on linux could be clearer
This updates the language in `install_arrow()` to follow the README revision that will land in https://github.com/apache/arrow/pull/4948/files#diff-563b2cb2c8c2d51b2ff6b177e2d84286R33. The [Jira ticket](https://issues.apache.org/jira/browse/ARROW-6142) requested three things; this is `#2` in the list. On `#1`, I defer to the C++ installation docs, which are already included in the install_arrow message, rather than duplicating content here. `#3` is out of scope. Closes apache#5027 from nealrichardson/no-ppa and squashes the following commits: 80b142e <Neal Richardson> s/arrow/Arrow/ 44c9659 <Neal Richardson> Tweak language again 36cfe28 <Neal Richardson> Further linux install revisions 79bd7e0 <Neal Richardson> One more PPurge 63f75bd <Neal Richardson> Revise install_arrow instructions for Linux Authored-by: Neal Richardson <neal.p.richardson@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
1 parent 6110ba6 commit 908b058

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

r/R/install-arrow.R

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ install_arrow_msg <- function(has_arrow, version, from_cran, os) {
5656
# Point to compilation instructions on readme
5757
msg <- c(SEE_DEV_GUIDE, THEN_REINSTALL)
5858
} else {
59-
# Suggest arrow.apache.org/install for PPAs, or compilation instructions
59+
# Suggest arrow.apache.org/install, or compilation instructions
6060
msg <- c(paste(SEE_ARROW_INSTALL, OR_SEE_DEV_GUIDE), THEN_REINSTALL)
6161
}
6262
} else if (!dev_version && !from_cran) {
@@ -98,7 +98,10 @@ OR_SEE_DEV_GUIDE <- paste0(
9898
SEE_ARROW_INSTALL <- paste(
9999
"See the Apache Arrow project installation page",
100100
"<https://arrow.apache.org/install/>",
101-
"for how to install the C++ package from a PPA."
101+
"to find pre-compiled binary packages for some common Linux distributions,",
102+
"including Debian, Ubuntu, and CentOS. You'll need to install",
103+
"'libparquet-dev' on Debian and Ubuntu, or 'parquet-devel' on CentOS. This",
104+
"will also automatically install the Arrow C++ library as a dependency."
102105
)
103106

104107
THEN_REINSTALL <- paste(

r/README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Install the latest release of `arrow` from CRAN with
3030
install.packages("arrow")
3131
```
3232

33-
On macOS and Windows, installing a binary package from CRAN will handle Arrow's C++ dependencies for you. On Linux, you'll need to first install the C++ library. See the [Arrow project installation page](https://arrow.apache.org/install/) for a list of PPAs from which you can obtain it.
33+
On macOS and Windows, installing a binary package from CRAN will handle Arrow's C++ dependencies for you. On Linux, you'll need to first install the C++ library. See the [Arrow project installation page](https://arrow.apache.org/install/) to find pre-compiled binary packages for some common Linux distributions, including Debian, Ubuntu, and CentOS. You'll need to install `libparquet-dev` on Debian and Ubuntu, or `parquet-devel` on CentOS. This will also automatically install the Arrow C++ library as a dependency.
3434

3535
If you install the `arrow` package from source and the C++ library is not found, the R package functions will notify you that Arrow is not available. Call
3636

r/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,11 @@ install.packages("arrow")
3030
On macOS and Windows, installing a binary package from CRAN will handle
3131
Arrow’s C++ dependencies for you. On Linux, you’ll need to first install
3232
the C++ library. See the [Arrow project installation
33-
page](https://arrow.apache.org/install/) for a list of PPAs from which
34-
you can obtain it.
33+
page](https://arrow.apache.org/install/) to find pre-compiled binary
34+
packages for some common Linux distributions, including Debian, Ubuntu,
35+
and CentOS. You’ll need to install `libparquet-dev` on Debian and
36+
Ubuntu, or `parquet-devel` on CentOS. This will also automatically
37+
install the Arrow C++ library as a dependency.
3538

3639
If you install the `arrow` package from source and the C++ library is
3740
not found, the R package functions will notify you that Arrow is not
@@ -57,7 +60,7 @@ set.seed(24)
5760

5861
tab <- arrow::table(x = 1:10, y = rnorm(10))
5962
tab$schema
60-
#> arrow::Schema
63+
#> arrow::Schema
6164
#> x: int32
6265
#> y: double
6366
tab

r/tests/testthat/test-install-arrow.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ r_only({
5151
test_that("Linux on release version gets pointed to PPA first, then C++", {
5252
expect_match(
5353
install_arrow_msg(FALSE, "0.13.0", os="linux"),
54-
"PPA. Or, see the Arrow C++ developer guide",
54+
"dependency. Or, see the Arrow C++ developer guide",
5555
fixed = TRUE
5656
)
5757
})

0 commit comments

Comments
 (0)