Skip to content

Commit

Permalink
ARROW-6142: [R] Install instructions on linux could be clearer
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
nealrichardson committed Aug 8, 2019
1 parent c894825 commit d0711ab
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 7 deletions.
7 changes: 5 additions & 2 deletions r/R/install-arrow.R
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ install_arrow_msg <- function(has_arrow, version, from_cran, os) {
# Point to compilation instructions on readme
msg <- c(SEE_DEV_GUIDE, THEN_REINSTALL)
} else {
# Suggest arrow.apache.org/install for PPAs, or compilation instructions
# Suggest arrow.apache.org/install, or compilation instructions
msg <- c(paste(SEE_ARROW_INSTALL, OR_SEE_DEV_GUIDE), THEN_REINSTALL)
}
} else if (!dev_version && !from_cran) {
Expand Down Expand Up @@ -98,7 +98,10 @@ OR_SEE_DEV_GUIDE <- paste0(
SEE_ARROW_INSTALL <- paste(
"See the Apache Arrow project installation page",
"<https://arrow.apache.org/install/>",
"for how to install the C++ package from a PPA."
"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."
)

THEN_REINSTALL <- paste(
Expand Down
2 changes: 1 addition & 1 deletion r/README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Install the latest release of `arrow` from CRAN with
install.packages("arrow")
```

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.
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.

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

Expand Down
9 changes: 6 additions & 3 deletions r/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,11 @@ install.packages("arrow")
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.
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.

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
Expand All @@ -52,7 +55,7 @@ set.seed(24)

tab <- arrow::table(x = 1:10, y = rnorm(10))
tab$schema
#> arrow::Schema
#> arrow::Schema
#> x: int32
#> y: double
tab
Expand Down
2 changes: 1 addition & 1 deletion r/tests/testthat/test-install-arrow.R
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ r_only({
test_that("Linux on release version gets pointed to PPA first, then C++", {
expect_match(
install_arrow_msg(FALSE, "0.13.0", os="linux"),
"PPA. Or, see the Arrow C++ developer guide",
"dependency. Or, see the Arrow C++ developer guide",
fixed = TRUE
)
})
Expand Down

0 comments on commit d0711ab

Please sign in to comment.