check_altair: Check the Altair installation

View source: R/install.R

check_altairR Documentation

Check the Altair installation

Description

Provides feedback on any differences between your installed version of Altair and the version this package supports.

Usage

check_altair(quiet = FALSE)

Arguments

quiet

logical, if TRUE, suppresses message upon successful check

Details

If the supported Altair version is different from your installed version, this function will act according to where the difference in the version numbers:

  • major version leads to an error

  • minor version leads to a warning

  • patch version leads to a message

If there is no difference:

  • quiet = FALSE, success message showing version-numbers

  • quiet = TRUE, no message

To install the supported version into a Python environment called "r-reticulate", use install_altair().

Value

invisible NULL, called for side-effects

See Also

reticulate::py_config(), install_altair(), altair_version()

Examples

## Not run: 
  # not run because it requires Python
  check_altair()

## End(Not run)

altair documentation built on Sept. 4, 2023, 9:06 a.m.