knitr::opts_chunk$set(echo = TRUE)

Installation

This page contains detailed instructions for installing the Toolchest R client.

If an installation problem persists, contact Toolchest directly, or file an issue on Github with the encountered errors.

Base Instructions

You can install the development version from GitHub with:

# install.packages("devtools") # uncomment to install devtools (prereq package)
devtools::install_github("trytoolchest/toolchest-client-r", dependencies = TRUE)
library(toolchest)

Requirements

R dependencies

The R client requires the reticulate package, version 1.25 or greater.

Install or update reticulate with:

install.packages("reticulate")

Python

The R client requires a version of Python 3.7 or greater.

A compatible version will automatically be installed via miniconda or pyenv, using R's reticulate package.

Troubleshooting

Updating reticulate

Some compatibility errors may occur during installation if reticulate is out-of-date. Check the package version:

packageVersion("reticulate")

If this is not 1.25 or greater, update the package with:

install.packages("reticulate")

Contact Toolchest if installation errors persist.



gotoolchest/toolchest-client-r documentation built on July 14, 2022, 7 a.m.