Skip to contents

Quick Install

Just quickly install Java in the current project

java_quick_install()
Download and install and set Java in current working/project directory

Quick Set & Discovery

Quickly find available versions, check system for existing ones, and set Java in the current project

use_java()
Install specified Java version and set the JAVA_HOME and PATH environment variables in current R session
java_list_available()
List Available Java Versions
java_find_system()
Discover system-wide Java installations
java_valid_versions()
Retrieve Valid Java Versions

Ensure Required Java Version

Ensure a specific Java version is available and set

java_ensure()
Ensure specific Java version is set
java_resolve()
Resolve path to specific Java version

Scoped Java Environment

Temporarily set Java for the current scope (ideal for package developers)

local_java_env()
Set Java environment for the current scope
with_java_env()
Execute code with a specific Java environment
with_rjava_env()
Execute rJava code in a separate process with specific Java version

Java Validation

Check Java version and compatibility with currently set environment

java_check_version_cmd()
Check installed Java version using terminal commands
java_check_version_rjava()
Check Java Version with a Specified JAVA_HOME Using a Separate R Session
java_get_home()
Get JAVA_HOME
java_check_compatibility()
Verify rJava Compatibility (Guard)

Fine-grained Control

Control every step of Java download, unpacking and installation

java_download()
Download a Java distribution
java_unpack()
Unpack a Java distribution file into cache directory
java_install()
Install Java from a distribution file
java_env_set()
Set the JAVA_HOME and PATH environment variables to a given path
java_env_unset()
Unset the JAVA_HOME and PATH environment variables in the project .Rprofile
java_build_env_set()
Set up the environment for building R packages with Java dependencies from source
java_build_env_unset()
Unset the Java build environment variables in the project .Rprofile

Cache Management

Manage cached downloads, installations, and project-linked Java versions

java_list()
List the contents of the Java versions installed or cached
java_list_distrib()
List the contents of the Java distributions cache folder
java_list_installed()
List the contents of the Java installations cache folder
java_list_project()
List the Java versions symlinked in the current project
java_clear()
Manage Java installations and distributions caches
java_clear_distrib()
Clear the Java distributions cache folder
java_clear_installed()
Clear the Java installations cache folder
java_clear_project()
Clear the Java versions symlinked in the current project

Other commands

rje_consent()
Obtain User Consent for rJavaEnv