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

Jump to bottom

packages are byte-compiled and JIT is enabled by default #291

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

packages are byte-compiled and JIT is enabled by default #291

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89d58eb
Update 03-programming.Rmd
atusy Oct 19, 2020
8ad2dad
Update 03-programming.Rmd
atusy Oct 19, 2020
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
21 changes: 2 additions & 19 deletions 03-programming.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,26 +657,9 @@ local(source("code/03-programming_f4.R", local = TRUE))

### Compiling code

There are a number of ways to compile code. The easiest is to compile individual functions using `cmpfun()`, but this obviously doesn't scale. If you create a package, you can automatically compile the package on installation by adding
There are a number of ways to compile code. The easiest is to compile individual functions using `cmpfun()`, but this obviously doesn't scale. If you create a package, you can automatically compile the package on installation. This is achieved by the `ByteCompile` logical field on the `DESCRIPTION` file, whose default value is `true`. Similarly, all packages are by default byte-compiled on installation since R 3.5.0.

```
ByteCompile: true
```

to the `DESCRIPTION` file. Most R packages installed using `install.packages()` are not compiled. We can enable (or force) packages to be compiled by starting R with the environment variable `R_COMPILE_PKGS` set to a positive integer value and specify that we install the package from `source`, i.e.

```{r eval=FALSE}
## Windows users will need Rtools
install.packages("ggplot2", type = "source")
```

Or if we want to avoid altering the `.Renviron` file, we can specify an additional argument

```{r eval=FALSE}
install.packages("ggplot2", type = "source", INSTALL_opts = "--byte-compile")
```

A final option is to use just-in-time (JIT) compilation. The `enableJIT()` function disables JIT compilation if the argument is `0`. Arguments `1`, `2`, or `3` implement different levels of optimisation. JIT can also be enabled by setting the environment variable `R_ENABLE_JIT`, to one of these values.
A final option is to use just-in-time (JIT) compilation. The `enableJIT()` function disables JIT compilation if the argument is `0`. Arguments `1`, `2`, or `3` implement different levels of optimisation. The defualt level is `3` and can be changed by the environment variable `R_ENABLE_JIT`.

```{block, type="rmdtip"}
We recommend setting the compile level to the maximum value of 3.
Expand Down