Skip to contents

Invoke shell command nix-build from an R session

Source: R/nix_build.R
nix_build.Rd

Invoke shell command nix-build from an R session

Usage

nix_build(project_path = ".", exec_mode = c("blocking", "non-blocking"))

Arguments

project_path

Path to the folder where the default.nix file resides. The default is ".", which is the working directory in the current R session.

exec_mode

Either "blocking" (default) or "non-blocking. This will either block the R session while the nix-build shell command is executed, or run nix-build in the background ("non-blocking").

Value

integer of the process ID (PID) of nix-build shell command launched, if nix_build() call is assigned to an R object. Otherwise, it will be returned invisibly.

Details

The nix-build command line interface has more arguments. We will probably not support all of them in this R wrapper, but currently we have support for the following nix-build flags:

  • --max-jobs: Maximum number of build jobs done in parallel by Nix. According to the official docs of Nix, it defaults to 1, which is one core. This option can be useful for shared memory multiprocessing or systems with high I/O latency. To set --max-jobs used, you can declare with options(rix.nix_build_max_jobs = <integer>). Once you call nix_build() the flag will be propagated to the call of nix-build.

Examples

if (FALSE) {
  nix_build()
}