Skip to content

Commit

Permalink
ARROW-15022: [R] install vignette and installation dev vignette need …
Browse files Browse the repository at this point in the history
…alt text for images

Closes #11972 from thisisnic/ARROW-15022_alt_text

Authored-by: Nic Crane <thisisnic@gmail.com>
Signed-off-by: Jonathan Keane <jkeane@gmail.com>
  • Loading branch information
thisisnic authored and jonkeane committed Dec 17, 2021
1 parent 6e20c6b commit 670af33
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
16 changes: 12 additions & 4 deletions r/vignettes/developers/install_details.Rmd
Expand Up @@ -57,23 +57,31 @@ correct components are described below.

The diagram below shows how the R package finds a libarrow installation on Windows.

```{r, echo=FALSE, out.width="70%"}
```{r, echo=FALSE, out.width="70%", fig.alt = "Flowchart of libarrow installation on Windows systems - find full descriptions in sections 'Checking for existing libarrow installations' and 'Downloading libarrow' below"}
knitr::include_graphics("./install_diagram_windows.png")
```

### Linux
#### Checking for existing libarrow installations

When you install the arrow R package on Windows, if the `ARROW_HOME` environment variable has not been set, the install script looks for an existing libarrow installation. If this cannot be find, it then checks whether the `R_WINLIB_LOCAL` environment variable has been set to point to a local installation.

#### Downloading libarrow

If no existing libarrow installations can be found, the script proceeds to try to download the required version of libarrow, first from the nightly builds repository and then from Rwinlib. The script first tries to find a version of libarrow which is matches the most components according to semantic versioning, and in the case of a failure becomes less specific (i.e. if there are no binaries found for version 0.14.1.1, then try to find one for 0.14.1).

### Non-Windows

The diagram below shows how the R package finds a libarrow installation on non-Windows systems.

```{r, echo=FALSE, out.width="70%"}
```{r, echo=FALSE, out.width="70%", fig.alt = "Flowchart of libarrow installation on non-Windows systems - find full description in sections 'Using pkg-config', 'Prebuilt binaries' and 'Building from source' below"}
knitr::include_graphics("./install_nix.png")
```

More information about these steps can be found below.

#### Using pkg-config

When you install the arrow R package on Linux, if no environment variables
When you install the arrow R package on non-Windows systems, if no environment variables
relating to the location of an existing libarrow installation have already by
set, the installation code will attempt to find libarrow on
your system using the `pkg-config` command.
Expand Down
6 changes: 3 additions & 3 deletions r/vignettes/install.Rmd
Expand Up @@ -29,7 +29,7 @@ For a faster installation, we recommend that you instead use one of the methods

### Method 1a - Binary R package containing libarrow binary via RSPM/conda

```{r, echo=FALSE, out.width="30%"}
```{r, echo=FALSE, out.width="30%", fig.alt = "Graphic showing R and C++ logo inside the package icon"}
knitr::include_graphics("./r_binary_libarrow_binary.png")
```

Expand All @@ -54,7 +54,7 @@ conda install -c conda-forge --strict-channel-priority r-arrow

### Method 1b - R source package with libarrow binary

```{r, echo=FALSE, out.width="50%"}
```{r, echo=FALSE, out.width="50%", fig.alt = "Graphic showing R logo in folder icon, then a plus sign, then C++ logo inside the package icon"}
knitr::include_graphics("./r_source_libarrow_binary.png")
```

Expand Down Expand Up @@ -102,7 +102,7 @@ The prebuilt libarrow binaries come with S3 support enabled, so you will need to

## Method 2 - Installing an R source package and building libarrow from source

```{r, echo=FALSE, out.width="50%"}
```{r, echo=FALSE, out.width="50%", fig.alt = "Graphic showing R inside a folder icon, then a plus sign, then C++ logo inside a folder icon"}
knitr::include_graphics("./r_source_libarrow_source.png")
```

Expand Down

0 comments on commit 670af33

Please sign in to comment.