fz (version 1.2.0)

fz_available: Check if fz Python Package is Available

Description

Checks whether the fz Python package is available in the current Python environment.

Usage

fz_available()

Value

Logical; TRUE if fz is available, FALSE otherwise.

Details

The importable module name of the funz-fz package is fz. This function returns TRUE only when a module named fz imports and exposes the expected API (fzi/fzc/fzo/ fzr), so that an unrelated Python package that also happens to be importable as fz is not mistaken for funz-fz. All examples and tests are guarded with if (fz_available()) and therefore skip (rather than error) when the Python side is missing or misconfigured.

Examples

# \donttest{
if (fz_available()) {
  message("fz is available!")
} else {
  message("Please install fz with fz_install()")
}
# }