install_altair {altair}R Documentation

Install Altair Python package

Description

This function wraps installation functions from reticulate to install the Python packages altair and vega_datasets.

Usage

install_altair(
  method = c("conda", "virtualenv"),
  envname = "r-reticulate",
  pip = FALSE,
  version = getOption("altair.python.version"),
  ...
)

Arguments

method

character, indicates to use "conda" or "virtualenv"

envname

character, name of environment into which to install

pip,

logical, used for conda installation to indicate to use pip (will be set to TRUE for release-candidates)

version

character, version of Altair to install. For general use of this package, this is set automatically, so you should not need to specify this.

...

other arguments sent to reticulate::conda_install() or reticulate::virtualenv_install()

Details

This package uses the reticulate package to make an interface with the Altair Python package. To promote consistency in usage of reticulate among different R packages, it is recommended to use a common Python environment, called "r-reticulate".

Depending on your setup, you can create this environment using reticulate::conda_create() or reticulate::virtualenv_create(), as described in this reticulate article, or in this package's Installation article.

Value

invisible NULL, called for side-effects

See Also

altiar: Installation, reticulate: Using reticulate in an R Package, reticulate: Installing Python Packages

Examples

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

## End(Not run)

[Package altair version 4.1.1 Index]