Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: minor updates for the install vignette #669

Merged
merged 4 commits into from
Jan 5, 2024
Merged

docs: minor updates for the install vignette #669

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5898744
docs: pl$polars_info -> polars_info
eitsupi Jan 5, 2024
9ee16dd
docs: add note about MY_UNIVERSE and minor update
eitsupi Jan 5, 2024
6879305
docs: pl$polars_info -> polars_info
eitsupi Jan 5, 2024
2d1e221
docs: rename the vignette
eitsupi Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions vignettes/install.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ If one of the following environment variables is set,
a pre-built Rust library binary will be tried to be used before building the Rust source.

- `NOT_CRAN="true"`
- `MY_UNIVERSE` is not empty (This environment variable is set by R-universe)
- `LIBR_POLARS_BUILD="false"` (This is prioritized, so if you want to force a source build, set `LIBR_POLARS_BUILD="true"`)

By default, the pre-built Rust library binary is downloaded from the URL recorded in `tools/lib-sums.tsv`.
Expand All @@ -96,7 +97,7 @@ or the hash of the downloaded file does not match the recorded one, it falls bac

If you want to use a pre-built Rust library binary that exists locally,
set the `LIBR_POLARS_PATH` environment variable to the path to the binary.
For example:
For example (on Bash):

```sh
export LIBR_POLARS_BUILD="false"
Expand All @@ -110,11 +111,11 @@ r-polars Rust library has some [feature flags](https://doc.rust-lang.org/cargo/r
that affect the R package features.
These flags are set at compile time, and cannot be changed at runtime.

The features enabled in the compiled Rust library are shown by the `pl$polars_info()` function.
The features enabled in the compiled Rust library are shown by the `polars_info()` function.

```{r}
library(polars)
pl$polars_info()
polars_info()
```

At this time, the following environment variables can be used to change the Rust library build time options.
Expand Down
Loading