Skip to contents

Check for Zonation 5 executable

Source: R/check_zonation_executable.R
check_zonation_executable.Rd

This function checks if the Zonation 5 executable is available on the system. It can verify a specific path provided by the user or search common installation locations. The function works on both Windows and Linux systems.

Usage

check_zonation_executable(zonation_path = NULL, os = NULL)

Arguments

zonation_path

Optional character string specifying the path to check. If not provided, the function will search common installation locations.

os

Operating system. If NULL (default), automatically detected from the system. Can be set to "Windows" or "Linux" manually.

Value

A list with the following components:

found

Logical indicating if the executable was found

path

Character string with the path where the executable was found (or NULL)

executable

Character string with the full path to the executable (or NULL)

os

Character string indicating the detected operating system

message

Character string with a descriptive message

Details

For Windows, the function searches for z5.exe in:

  • The provided path (if given)

  • C:/Program Files (x86)/Zonation5

  • C:/Program Files/Zonation5

For Linux, the function searches for zonation5 in:

  • The provided path (if given)

  • Common locations like ~/Applications, ~/bin, /usr/local/bin, /usr/bin

  • The system PATH

See also

Other preflight: check_dir_writable(), check_raster_uniformity()

Examples

if (FALSE) { # \dontrun{
# Check common installation locations
check_zonation_executable()

# Check a specific path
check_zonation_executable(zonation_path = "C:/Program Files (x86)/Zonation5")

# Check on Linux
check_zonation_executable(zonation_path = "~/Applications")
} # }