Install
diff --git a/pkgdown.yml b/pkgdown.yml
index 8e3e5c1..3ae2331 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 2.0.9
pkgdown_sha: ~
articles:
rJavaEnv: rJavaEnv.html
-last_built: 2024-05-31T13:21Z
+last_built: 2024-05-31T13:40Z
urls:
reference: http://www.ekotov.pro/rJavaEnv/reference
article: http://www.ekotov.pro/rJavaEnv/articles
diff --git a/search.json b/search.json
index a5ec8ef..11562a3 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":[]},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement kotov.egor@gmail.com. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to rJavaEnv","title":"Contributing to rJavaEnv","text":"outlines propose change rJavaEnv. detailed discussion contributing tidyverse packages, please see development contributing guide code review principles.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to rJavaEnv","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to rJavaEnv","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed). See guide create great issue advice.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to rJavaEnv","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"e-kotov/rJavaEnv\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to rJavaEnv","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to rJavaEnv","text":"Please note rJavaEnv project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 rJavaEnv authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-1-download-and-install-java","dir":"Articles","previous_headings":"","what":"Step 1: Download and Install Java","title":"Quick Start Guide: Java Setup for R Projects","text":"Install rJavaEnv: First, install development version rJavaEnv GitHub: Quick Install Java: quickly install Java 21 (default) current project directory set environment: command: Downloads Java distribution compatible OS architecture. Installs Java cache directory. Sets JAVA_HOME PATH environment variables current session project. Expected output: Step--Step Installation: prefer controlled process: Download Java: download Java 21 Corretto distribution. Expected output: Install Java: install downloaded Java distribution set JAVA_HOME PATH environment variables. Expected output:","code":"devtools::install_github(\"e-kotov/rJavaEnv\") library(rJavaEnv) java_quick_install() Platform detected or provided:
Architecture detected or provided: Downloading Java 21 (Corretto) for to Download completed. Java 21 (Corretto) for installed at and symlinked to java_distr_path <- java_download(version = 21, distribution = \"Corretto\") Downloading Java 21 (Corretto) for to Download completed. java_home_path <- java_install(java_distr_path) Java 21 (Corretto) installed at and symlinked to "},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-2-set-java-environment","dir":"Articles","previous_headings":"","what":"Step 2: Set Java Environment","title":"Quick Start Guide: Java Setup for R Projects","text":"Set JAVA_HOME PATH environment variables installed Java directory: function sets JAVA_HOME PATH environment variables current R session /project .Rprofile file. Expected output:","code":"java_env_set(java_home_path) Current R Session: JAVA_HOME and PATH set to Current R Project/Working Directory: JAVA_HOME and PATH set to in .Rprofile in "},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-3-unset-java-environment","dir":"Articles","previous_headings":"","what":"Step 3: Unset Java Environment","title":"Quick Start Guide: Java Setup for R Projects","text":"Remove JAVA_HOME PATH environment variables settings project .Rprofile file: function removes JAVA_HOME PATH environment variables .Rprofile file project directory. Expected output:","code":"java_env_unset() Removed JAVA_HOME settings from .Rprofile in "},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-4-manage-java-distributions","dir":"Articles","previous_headings":"","what":"Step 4: Manage Java Distributions","title":"Quick Start Guide: Java Setup for R Projects","text":"List Cached Java Distributions: function lists Java distributions cached user-specific data directory. Expected output: Clear Cached Java Distributions: function clears cached Java distributions. Expected output:","code":"java_list(type = \"distrib\") java_clear(type = \"distrib\") Java distributions cache cleared."},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-5-manage-installed-java-versions","dir":"Articles","previous_headings":"","what":"Step 5: Manage Installed Java Versions","title":"Quick Start Guide: Java Setup for R Projects","text":"List Installed Java Versions: function lists installed Java versions user-specific data directory. Expected output: Clear Installed Java Versions: function clears installed Java versions. Expected output:","code":"java_list(type = \"installed\") java_clear(type = \"installed\") Java installations cache cleared."},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-6-manage-project-specific-java-versions","dir":"Articles","previous_headings":"","what":"Step 6: Manage Project-Specific Java Versions","title":"Quick Start Guide: Java Setup for R Projects","text":"List Project-Specific Java Versions: function lists Java versions symlinked current project directory. Expected output: Clear Project-Specific Java Versions: function clears Java versions symlinked current project directory. Expected output:","code":"java_list(type = \"project\") java_clear(type = \"project\") All Java symlinks in the project have been cleared."},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-7-check-java-version","dir":"Articles","previous_headings":"","what":"Step 7: Check Java Version","title":"Quick Start Guide: Java Setup for R Projects","text":"Check Installed Java Version using Terminal Commands: function checks Java version using terminal commands prints Java version path. Expected output: Check Java Version using rJava Separate R Session: function checks Java version using rJava separate R session. Expected output:","code":"java_check_version_cmd() JAVA_HOME: Java path: Java version: java_check_version_rjava(\"/path/to/installed/java\") With the current session's JAVA_HOME or With the user-specified JAVA_HOME "},{"path":"http://www.ekotov.pro/rJavaEnv/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Egor Kotov. Author, maintainer, copyright holder.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Kotov E (2024). rJavaEnv: Java Environments R Projects. https://github.com/e-kotov/rJavaEnv.","code":"@Manual{rjavaenv, title = {rJavaEnv: Java Environments for R Projects}, author = {Egor Kotov}, year = {2024}, url = {https://github.com/e-kotov/rJavaEnv}, }"},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"rjavaenv-java-environments-for-r-projects-","dir":"","previous_headings":"","what":"rJavaEnv: Java Environments for R Projects","title":"rJavaEnv: Java Environments for R Projects","text":"goal rJavaEnv manage multiple Java JDKs R projects automating process downloading, installing, configuring Java environments per-project basis. package inspired renv package managing R environments R projects. can request specific Java Development Kit (JDK) project, rJavaEnv download install requested Java environment project-specific directory set PATH JAVA_HOME using project. Therefore, can different Java versions different projects without contaminating system different Java versions. WARNING package early stages development yet ready production use. Please test thoroughly using projects. 0","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"install","dir":"","previous_headings":"","what":"Install","title":"rJavaEnv: Java Environments for R Projects","text":"can install development version rJavaEnv GitHub:","code":"devtools::install_github(\"e-kotov/rJavaEnv\")"},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"simple-example","dir":"","previous_headings":"","what":"Simple Example","title":"rJavaEnv: Java Environments for R Projects","text":": download Java 21 distribution compatible current operating system processor architecture local cache folder; extract downloaded Java distribution another cache folder; create symbolic link (macOS Linux) junction (Windows, fails, just copies files) rjavaenv/platform/processor_architecture/java_version current directory/project point cached installation; set current session’s JAVA_HOME PATH environment variables point installed (symlinked) Java distribution; add code .Rprofile file current directory/project set JAVA_HOME PATH environment variables project opened RStudio. , can even remove rJavaEnv completely, Java environment set project directory base R code rely rJavaEnv.","code":"rJavaEnv::java_quick_install(version = 21)"},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"functions-overview","dir":"","previous_headings":"","what":"Functions Overview","title":"rJavaEnv: Java Environments for R Projects","text":"package several core functions: Downloads, installs, sets Java environment current working/project directory, one line code. Checks installed Java version using terminal commands. packages like opentripplanner, performs Java calls using command line. Checks installed Java version using rJava separate R session. rJava-dependent packages r5r. Downloads specified version distribution Java. Installs Java distribution file current (user-specified) project directory. Sets JAVA_HOME PATH environment variables given path current R session /.Rprofile file project directory. Remove JAVA_HOME PATH environment variables .Rpofile file project directory (current R session, please restart session R picks system Java). Lists Java versions linked current project (cached distributions installations). Removes Java versions linked current project (cached distributions installations). See details functions Reference. detailed usage, see Quick Start Vignette (work progress).","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"limitations","dir":"","previous_headings":"","what":"Limitations","title":"rJavaEnv: Java Environments for R Projects","text":"Currently, rJavaEnv supports major Java versions 8, 11, 17, 21, 22. download install functions ignore minor version Java distribution just downloads latest stable subversion specified major version. done simplify process avoid need update package every time new minor version Java released. users sufficient, substandard full reproducibility. main limitation want switch another Java environment, likely restart current R session set JAVA_HOME PATH environment variables desired Java environment using rJavaEnv::java_env_set(). done dynamically within R session due way Java initialized R, particularly rJava-dependent packages r5r. packages like opentripplanner, performs Java calls using command line, can switch Java environments dynamically within R session much want. Therefore, need use R packages depend different Java versions within project, create separate R scripts Java environment run separate R sessions. One effective way use callr package run R scripts separate R sessions. Another option use targets package manage whole project workflow, , side effect, lead R scripts run separate R sessions. use rJavaEnv targets, need download install several Java environments using rJavaEnv::java_download() rJavaEnv::java_install() set relevant path rJavaEnv::java_env_set() beginning function requires certain Java version.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"future-work","dir":"","previous_headings":"","what":"Future work","title":"rJavaEnv: Java Environments for R Projects","text":"future work includes: Add support Java distributions versions Take care R CMD javareconf Possibly add support specifying Java version beyond major version Possibly allow downloading several Java distributions one function call, e.g. different major versions ‘flavour’ different ‘flavours’ major version Possibly add automation get Java required specific Java-dependent R packages open suggestions contributions, welcome issues pull requests.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"acknowledgements","dir":"","previous_headings":"","what":"Acknowledgements","title":"rJavaEnv: Java Environments for R Projects","text":"thank rOpenSci Dev Guide, well Hadley Wickham Jennifer Bryan R Packages book. Package hex sticker logo partially generated DALL-E OpenAI. logo also contains original R logo.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"rJavaEnv: Java Environments for R Projects","text":"cite package ‘rJavaEnv’ publications use: Kotov E (2024). rJavaEnv: Java Environments R Projects. https://github.com/e-kotov/rJavaEnv. BibTeX:","code":"@Manual{rjavaenv, title = {rJavaEnv: Java Environments for R Projects}, author = {Egor Kotov}, year = {2024}, url = {https://github.com/e-kotov/rJavaEnv}, }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":null,"dir":"Reference","previous_headings":"","what":"Check installed Java version using terminal commands — java_check_version_cmd","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"Check installed Java version using terminal commands","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"","code":"java_check_version_cmd(java_home = NULL)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"java_home Path Java home directory. NULL, function uses JAVA_HOME environment variable.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"TRUE successful, otherwise FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"","code":"java_check_version_cmd() #> JAVA_HOME: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> Java path: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8/bin/java #> Java version: \"openjdk version \\\"1.8.0_412\\\" OpenJDK Runtime Environment #> Corretto-8.412.08.1 (build 1.8.0_412-b08) OpenJDK 64-Bit Server VM #> Corretto-8.412.08.1 (build 25.412-b08, mixed mode)\" #> [1] TRUE"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":null,"dir":"Reference","previous_headings":"","what":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"function sets JAVA_HOME environment variable, initializes JVM using rJava, prints Java version used user sets given JAVA_HOME current R session. check performed separate R session avoid reload current R session. reason Java initialized R session, uninitialized unless current R session restarted.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"","code":"java_check_version_rjava(java_home = NULL, verbose = TRUE)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"java_home path desired JAVA_HOME. NULL, uses current JAVA_HOME environment variable. verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"TRUE successful, otherwise FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"","code":"java_check_version_rjava() #> Using current session's JAVA_HOME: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> With the user-specified JAVA_HOME rJava and other rJava/Java-based packages #> will use Java version: \"1.8.0_412\" #> [1] TRUE"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_system.html","id":null,"dir":"Reference","previous_headings":"","what":"Check and print Java path and version — java_check_version_system","title":"Check and print Java path and version — java_check_version_system","text":"function checks Java executable path retrieves Java version, prints details console.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_system.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check and print Java path and version — java_check_version_system","text":"","code":"java_check_version_system()"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_system.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check and print Java path and version — java_check_version_system","text":"TRUE successful, otherwise FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":null,"dir":"Reference","previous_headings":"","what":"Manage Java installations and distributions caches — java_clear","title":"Manage Java installations and distributions caches — java_clear","text":"Wrapper function clear Java symlinked current project, installed, distributions caches.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Manage Java installations and distributions caches — java_clear","text":"","code":"java_clear( type = c(\"project\", \"installed\", \"distrib\"), target_dir = NULL, check = TRUE, delete_all = FALSE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Manage Java installations and distributions caches — java_clear","text":"type clear: \"project\" - remove symlinks install cache current project, \"installed\" - remove installed Java versions, \"distrib\" - remove downloaded Java distributions. target_dir directory clear. Defaults current working directory \"project\" user-specific data directory \"installed\" \"distrib\". recommended change. check Whether list contents cache directory clearing . Defaults TRUE. delete_all Whether delete items without prompting. Defaults FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Manage Java installations and distributions caches — java_clear","text":"message indicating whether cache cleared .","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Manage Java installations and distributions caches — java_clear","text":"","code":"java_clear(\"project\") #> Java symlink directory does not exist in the project. java_clear(\"installed\") #> Contents of the Java installations cache folder: #> ℹ Existing Java installations: #> 1: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/17 #> 2: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/21 #> 3: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> ℹ Enter the number of the installation to delete, 'all' to delete all, or '0' or any other character to cancel: #> No installations were cleared. java_clear(\"distrib\") #> ℹ Existing Java distributions: #> 1: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-17-aarch64-macos-jdk.tar.gz #> 2: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-21-aarch64-macos-jdk.tar.gz #> 3: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-22-aarch64-macos-jdk.tar.gz #> 4: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-8-aarch64-macos-jdk.tar.gz #> ℹ Enter the number of the distribution to delete, 'all' to delete all, or '0' or any other character to cancel: #> No distributions were cleared."},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"Clear the Java distributions cache folder — java_clear_distrib_cache","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"Clear Java distributions cache folder","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"","code":"java_clear_distrib_cache( check = TRUE, delete_all = FALSE, cache_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\") )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"check Whether list contents cache directory clearing . Defaults TRUE. delete_all Whether delete distributions without prompting. Defaults FALSE. cache_dir cache directory clear. Defaults user-specific data directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"message indicating whether cache cleared .","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"","code":"if (FALSE) { java_clear_distrib_cache() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":null,"dir":"Reference","previous_headings":"","what":"Clear the Java versions symlinked in the current project — java_clear_in_project","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"Clear Java versions symlinked current project","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"","code":"java_clear_in_project(project_dir = getwd(), check = TRUE, delete_all = FALSE)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"project_dir project directory clear. Defaults current working directory. check Whether list symlinked Java versions clearing . Defaults TRUE. delete_all Whether delete symlinks without prompting. Defaults FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"message indicating whether symlinks cleared .","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"","code":"if (FALSE) { java_clear_in_project() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"Clear the Java installations cache folder — java_clear_installed_cache","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"Clear Java installations cache folder","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"","code":"java_clear_installed_cache( check = TRUE, delete_all = FALSE, cache_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\") )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"check Whether list contents cache directory clearing . Defaults TRUE. delete_all Whether delete installations without prompting. Defaults FALSE. cache_dir cache directory clear. Defaults user-specific data directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"message indicating whether cache cleared .","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"","code":"if (FALSE) { java_clear_installed_cache() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a Java distribution — java_download","title":"Download a Java distribution — java_download","text":"Download Java distribution","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a Java distribution — java_download","text":"","code":"java_download( version = 21, distribution = \"Corretto\", dest_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\"), platform = platform_detect()$os, arch = platform_detect()$arch, verbose = TRUE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a Java distribution — java_download","text":"version Java version download. specified, defaults latest LTS version. distribution Java distribution download. specified, defaults \"Corretto\". dest_dir destination directory download Java distribution . Defaults user-specific data directory. platform platform download Java distribution. Defaults current platform. arch architecture download Java distribution. Defaults current architecture. verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a Java distribution — java_download","text":"path downloaded Java distribution file.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download a Java distribution — java_download","text":"","code":"if (FALSE) { java_download(version = \"17\", distribution = \"Corretto\") java_download(distribution = \"Corretto\") java_download() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"Set JAVA_HOME PATH environment variables given path","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"","code":"java_env_set(java_home, where = c(\"both\", \"session\", \"project\"), verbose = T)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"java_home path desired JAVA_HOME. set JAVA_HOME: \"session\", \"project\", \"\". Defaults \"\". \"\" \"project\" selected, function updates .Rprofile file project directory set JAVA_HOME PATH environment variables start R session. verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"Nothing. Sets JAVA_HOME PATH environment variables.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"","code":"if (FALSE) { java_env_set(\"/path/to/java\", \"both\") }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_rprofile.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the .Rprofile file in the project directory — java_env_set_rprofile","title":"Update the .Rprofile file in the project directory — java_env_set_rprofile","text":"Update .Rprofile file project directory","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_rprofile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the .Rprofile file in the project directory — java_env_set_rprofile","text":"","code":"java_env_set_rprofile(java_home)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_rprofile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the .Rprofile file in the project directory — java_env_set_rprofile","text":"java_home path desired JAVA_HOME.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_session.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the JAVA_HOME and PATH environment variables for the current session — java_env_set_session","title":"Set the JAVA_HOME and PATH environment variables for the current session — java_env_set_session","text":"Set JAVA_HOME PATH environment variables current session","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_session.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the JAVA_HOME and PATH environment variables for the current session — java_env_set_session","text":"","code":"java_env_set_session(java_home)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_session.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the JAVA_HOME and PATH environment variables for the current session — java_env_set_session","text":"java_home path desired JAVA_HOME.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":null,"dir":"Reference","previous_headings":"","what":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"Unset JAVA_HOME PATH environment variables project .Rprofile","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"","code":"java_env_unset(verbose = TRUE)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"Nothing. Removes JAVA_HOME PATH environment variables settings project .Rprofile.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"","code":"if (FALSE) { java_env_unset() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":null,"dir":"Reference","previous_headings":"","what":"Install Java from a distribution file — java_install","title":"Install Java from a distribution file — java_install","text":"Install Java distribution file","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install Java from a distribution file — java_install","text":"","code":"java_install( java_path, project = NULL, autoset_java_path = TRUE, verbose = TRUE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install Java from a distribution file — java_install","text":"java_path path Java distribution file. project project directory Java installed. Defaults current working directory. autoset_java_path Whether set JAVA_HOME PATH environment variables installed Java directory. Defaults TRUE. verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Install Java from a distribution file — java_install","text":"path installed Java directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install Java from a distribution file — java_install","text":"","code":"if (FALSE) { java_install(\"path/to/any-java-17-aarch64-macos-jdk.tar.gz\") }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List the contents of the Java cache — java_list","title":"List the contents of the Java cache — java_list","text":"List contents Java cache","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List the contents of the Java cache — java_list","text":"","code":"java_list( type = c(\"project\", \"installed\", \"distrib\"), output = c(\"data.frame\", \"vector\"), verbose = FALSE, target_dir = NULL )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List the contents of the Java cache — java_list","text":"type type cache list: \"distrib\", \"installed\", \"project\". output format output: \"data.frame\" \"vector\". Defaults \"data.frame\". verbose Whether print detailed messages. Defaults FALSE. target_dir cache directory list. Defaults user-specific data directory \"distrib\" \"installed\", current working directory \"project\".","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List the contents of the Java cache — java_list","text":"data frame character vector contents specified cache directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List the contents of the Java cache — java_list","text":"","code":"java_list(\"project\") #> ✖ Project Java symlink directory does not exist #> character(0) java_list(\"installed\") #> path #> 1 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/17 #> 2 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/21 #> 3 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> platform arch version #> 1 macos aarch64 17 #> 2 macos aarch64 21 #> 3 macos aarch64 8 java_list(\"distrib\") #> java_distr_path #> 1 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-17-aarch64-macos-jdk.tar.gz #> 2 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-21-aarch64-macos-jdk.tar.gz #> 3 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-22-aarch64-macos-jdk.tar.gz #> 4 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-8-aarch64-macos-jdk.tar.gz"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"List the contents of the Java distributions cache folder — java_list_distrib_cache","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"List contents Java distributions cache folder","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"","code":"java_list_distrib_cache( output = c(\"data.frame\", \"vector\"), verbose = FALSE, cache_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\") )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"output format output: \"data.frame\" \"vector\". Defaults \"data.frame\". verbose Whether print detailed messages. Defaults FALSE. cache_dir cache directory list. Defaults user-specific data directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"character vector contents cache directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"","code":"java_list_distrib_cache() #> java_distr_path #> 1 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-17-aarch64-macos-jdk.tar.gz #> 2 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-21-aarch64-macos-jdk.tar.gz #> 3 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-22-aarch64-macos-jdk.tar.gz #> 4 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-8-aarch64-macos-jdk.tar.gz"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":null,"dir":"Reference","previous_headings":"","what":"List the Java versions symlinked in the current project — java_list_in_project","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"List Java versions symlinked current project","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"","code":"java_list_in_project( project_dir = getwd(), output = c(\"data.frame\", \"vector\"), verbose = FALSE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"project_dir project directory list. Defaults current working directory. output format output: \"data.frame\" \"vector\". Defaults \"data.frame\". verbose Whether print detailed messages. Defaults FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"data frame character vector symlinked Java versions project directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"","code":"java_list_in_project() #> ✖ Project Java symlink directory does not exist #> character(0)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"List the contents of the Java installations cache folder — java_list_installed_cache","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"List contents Java installations cache folder","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"","code":"java_list_installed_cache( output = c(\"data.frame\", \"vector\"), verbose = FALSE, cache_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\") )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"output format output: \"data.frame\" \"vector\". Defaults \"data.frame\". verbose Whether print detailed messages. Defaults FALSE. cache_dir cache directory list. Defaults user-specific data directory. recommended change.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"data frame character vector contents cache directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"","code":"java_list_installed_cache() #> path #> 1 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/17 #> 2 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/21 #> 3 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> platform arch version #> 1 macos aarch64 17 #> 2 macos aarch64 21 #> 3 macos aarch64 8"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":null,"dir":"Reference","previous_headings":"","what":"Download and install and set Java in current working/project directory — java_quick_install","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"Download install set Java current working/project directory","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"","code":"java_quick_install( version = 21, distribution = \"Corretto\", platform = platform_detect()$os, arch = platform_detect()$arch, verbose = TRUE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"version Java version download. specified, defaults latest LTS version. distribution Java distribution download. specified, defaults \"Corretto\". platform platform download Java distribution. Defaults current platform. arch architecture download Java distribution. Defaults current architecture. verbose Whether print messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"Message indicating Java installed set current working/project directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"","code":"if (FALSE) { java_quick_install() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_urls_load.html","id":null,"dir":"Reference","previous_headings":"","what":"Load Java URLs from JSON file — java_urls_load","title":"Load Java URLs from JSON file — java_urls_load","text":"Load Java URLs JSON file","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_urls_load.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load Java URLs from JSON file — java_urls_load","text":"","code":"java_urls_load()"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_urls_load.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load Java URLs from JSON file — java_urls_load","text":"list Java URLs structured JSON file distribution, platform, architecture.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_version_check_rscript.html","id":null,"dir":"Reference","previous_headings":"","what":"Check Java version using rJava — java_version_check_rscript","title":"Check Java version using rJava — java_version_check_rscript","text":"Check Java version using rJava","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_version_check_rscript.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check Java version using rJava — java_version_check_rscript","text":"","code":"java_version_check_rscript(java_home)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_version_check_rscript.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check Java version using rJava — java_version_check_rscript","text":"java_home","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_version_check_rscript.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check Java version using rJava — java_version_check_rscript","text":"message Java version error message.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/platform_detect.html","id":null,"dir":"Reference","previous_headings":"","what":"Detect platform and architecture — platform_detect","title":"Detect platform and architecture — platform_detect","text":"Detect platform architecture","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/platform_detect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Detect platform and architecture — platform_detect","text":"","code":"platform_detect(verbose = FALSE)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/platform_detect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Detect platform and architecture — platform_detect","text":"verbose Whether print detailed messages. Defaults FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/platform_detect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Detect platform and architecture — platform_detect","text":"list length 2 detected platform architecture.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/rJavaEnv-package.html","id":null,"dir":"Reference","previous_headings":"","what":"rJavaEnv: Java Environments for R Projects — rJavaEnv-package","title":"rJavaEnv: Java Environments for R Projects — rJavaEnv-package","text":"Install specific version Java runtime environment R project level. goal rJavaEnv manage multiple Java JDKs R projects automatingthe process downloading, installing, configuring Java environments per-project basis. package inspired renv https://rstudio.github.io/renv/ package managing R environments R projects. can request specific Java Development Kit (JDK) project, rJavaEnv download install requested Java environment project-specific directory set PATH JAVA_HOME using project. Therefore, can different Java versions different projects without contaminating system different Java versions.","code":""},{"path":[]},{"path":"http://www.ekotov.pro/rJavaEnv/reference/rJavaEnv-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"rJavaEnv: Java Environments for R Projects — rJavaEnv-package","text":"Maintainer: Egor Kotov kotov.egor@gmail.com (ORCID) [copyright holder]","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/urls_test_all.html","id":null,"dir":"Reference","previous_headings":"","what":"Test all Java URLs — urls_test_all","title":"Test all Java URLs — urls_test_all","text":"Test Java URLs","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/urls_test_all.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Test all Java URLs — urls_test_all","text":"","code":"urls_test_all()"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/urls_test_all.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Test all Java URLs — urls_test_all","text":"list results testing Java URLs.","code":""},{"path":[]},{"path":"http://www.ekotov.pro/rJavaEnv/news/index.html","id":"initial-release-0-0-1","dir":"Changelog","previous_headings":"","what":"Initial release","title":"version 0.0.1","text":"Initial release","code":""},{"path":[]},{"path":"http://www.ekotov.pro/rJavaEnv/news/index.html","id":"newsmd-setup-0-0-0-9000","dir":"Changelog","previous_headings":"","what":"NEWS.md setup","title":"version 0.0.0.9000","text":"added NEWS.md creation newsmd","code":""}]
+[{"path":[]},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement kotov.egor@gmail.com. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to rJavaEnv","title":"Contributing to rJavaEnv","text":"outlines propose change rJavaEnv. detailed discussion contributing tidyverse packages, please see development contributing guide code review principles.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to rJavaEnv","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to rJavaEnv","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed). See guide create great issue advice.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to rJavaEnv","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"e-kotov/rJavaEnv\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to rJavaEnv","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to rJavaEnv","text":"Please note rJavaEnv project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 rJavaEnv authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-1-download-and-install-java","dir":"Articles","previous_headings":"","what":"Step 1: Download and Install Java","title":"Quick Start Guide: Java Setup for R Projects","text":"Install rJavaEnv: First, install development version rJavaEnv GitHub: Quick Install Java: quickly install Java 21 (default) current project directory set environment: command: Downloads Java distribution compatible OS architecture. Installs Java cache directory. Sets JAVA_HOME PATH environment variables current session project. Expected output: Step--Step Installation: prefer controlled process: Download Java: download Java 21 Corretto distribution. Expected output: Install Java: install downloaded Java distribution set JAVA_HOME PATH environment variables. Expected output:","code":"devtools::install_github(\"e-kotov/rJavaEnv\") library(rJavaEnv) java_quick_install() Platform detected or provided: Architecture detected or provided: Downloading Java 21 (Corretto) for to Download completed. Java 21 (Corretto) for installed at and symlinked to java_distr_path <- java_download(version = 21, distribution = \"Corretto\") Downloading Java 21 (Corretto) for to Download completed. java_home_path <- java_install(java_distr_path) Java 21 (Corretto) installed at and symlinked to "},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-2-set-java-environment","dir":"Articles","previous_headings":"","what":"Step 2: Set Java Environment","title":"Quick Start Guide: Java Setup for R Projects","text":"Set JAVA_HOME PATH environment variables installed Java directory: function sets JAVA_HOME PATH environment variables current R session /project .Rprofile file. Expected output:","code":"java_env_set(java_home_path) Current R Session: JAVA_HOME and PATH set to Current R Project/Working Directory: JAVA_HOME and PATH set to in .Rprofile in "},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-3-unset-java-environment","dir":"Articles","previous_headings":"","what":"Step 3: Unset Java Environment","title":"Quick Start Guide: Java Setup for R Projects","text":"Remove JAVA_HOME PATH environment variables settings project .Rprofile file: function removes JAVA_HOME PATH environment variables .Rprofile file project directory. Expected output:","code":"java_env_unset() Removed JAVA_HOME settings from .Rprofile in "},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-4-manage-java-distributions","dir":"Articles","previous_headings":"","what":"Step 4: Manage Java Distributions","title":"Quick Start Guide: Java Setup for R Projects","text":"List Cached Java Distributions: function lists Java distributions cached user-specific data directory. Expected output: Clear Cached Java Distributions: function clears cached Java distributions. Expected output:","code":"java_list(type = \"distrib\") java_clear(type = \"distrib\") Java distributions cache cleared."},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-5-manage-installed-java-versions","dir":"Articles","previous_headings":"","what":"Step 5: Manage Installed Java Versions","title":"Quick Start Guide: Java Setup for R Projects","text":"List Installed Java Versions: function lists installed Java versions user-specific data directory. Expected output: Clear Installed Java Versions: function clears installed Java versions. Expected output:","code":"java_list(type = \"installed\") java_clear(type = \"installed\") Java installations cache cleared."},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-6-manage-project-specific-java-versions","dir":"Articles","previous_headings":"","what":"Step 6: Manage Project-Specific Java Versions","title":"Quick Start Guide: Java Setup for R Projects","text":"List Project-Specific Java Versions: function lists Java versions symlinked current project directory. Expected output: Clear Project-Specific Java Versions: function clears Java versions symlinked current project directory. Expected output:","code":"java_list(type = \"project\") java_clear(type = \"project\") All Java symlinks in the project have been cleared."},{"path":"http://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html","id":"step-7-check-java-version","dir":"Articles","previous_headings":"","what":"Step 7: Check Java Version","title":"Quick Start Guide: Java Setup for R Projects","text":"Check Installed Java Version using Terminal Commands: function checks Java version using terminal commands prints Java version path. Expected output: Check Java Version using rJava Separate R Session: function checks Java version using rJava separate R session. Expected output:","code":"java_check_version_cmd() JAVA_HOME: Java path: Java version: java_check_version_rjava(\"/path/to/installed/java\") With the current session's JAVA_HOME or With the user-specified JAVA_HOME "},{"path":"http://www.ekotov.pro/rJavaEnv/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Egor Kotov. Author, maintainer, copyright holder.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Kotov E (2024). rJavaEnv: Java Environments R Projects. https://github.com/e-kotov/rJavaEnv.","code":"@Manual{rjavaenv, title = {rJavaEnv: Java Environments for R Projects}, author = {Egor Kotov}, year = {2024}, url = {https://github.com/e-kotov/rJavaEnv}, }"},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"rjavaenv-java-environments-for-r-projects-","dir":"","previous_headings":"","what":"rJavaEnv: Java Environments for R Projects","title":"rJavaEnv: Java Environments for R Projects","text":"goal rJavaEnv manage multiple Java JDKs R projects automating process downloading, installing, configuring Java environments per-project basis. package inspired renv package managing R environments R projects. can request specific Java Development Kit (JDK) project, rJavaEnv download install requested Java environment project-specific directory set PATH JAVA_HOME using project. Therefore, can different Java versions different projects without contaminating system different Java versions. WARNING package early stages development yet ready production use. Please test thoroughly using projects.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"install","dir":"","previous_headings":"","what":"Install","title":"rJavaEnv: Java Environments for R Projects","text":"can install development version rJavaEnv GitHub:","code":"devtools::install_github(\"e-kotov/rJavaEnv\")"},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"simple-example","dir":"","previous_headings":"","what":"Simple Example","title":"rJavaEnv: Java Environments for R Projects","text":": download Java 21 distribution compatible current operating system processor architecture local cache folder; extract downloaded Java distribution another cache folder; create symbolic link (macOS Linux) junction (Windows, fails, just copies files) rjavaenv/platform/processor_architecture/java_version current directory/project point cached installation; set current session’s JAVA_HOME PATH environment variables point installed (symlinked) Java distribution; add code .Rprofile file current directory/project set JAVA_HOME PATH environment variables project opened RStudio. , can even remove rJavaEnv completely, Java environment set project directory base R code rely rJavaEnv.","code":"rJavaEnv::java_quick_install(version = 21)"},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"functions-overview","dir":"","previous_headings":"","what":"Functions Overview","title":"rJavaEnv: Java Environments for R Projects","text":"package several core functions: Downloads, installs, sets Java environment current working/project directory, one line code. Checks installed Java version using terminal commands. packages like opentripplanner, performs Java calls using command line. Checks installed Java version using rJava separate R session. rJava-dependent packages r5r. Downloads specified version distribution Java. Installs Java distribution file current (user-specified) project directory. Sets JAVA_HOME PATH environment variables given path current R session /.Rprofile file project directory. Remove JAVA_HOME PATH environment variables .Rpofile file project directory (current R session, please restart session R picks system Java). Lists Java versions linked current project (cached distributions installations). Removes Java versions linked current project (cached distributions installations). See details functions Reference. detailed usage, see Quick Start Vignette (work progress).","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"limitations","dir":"","previous_headings":"","what":"Limitations","title":"rJavaEnv: Java Environments for R Projects","text":"Currently, rJavaEnv supports major Java versions 8, 11, 17, 21, 22. download install functions ignore minor version Java distribution just downloads latest stable subversion specified major version. done simplify process avoid need update package every time new minor version Java released. users sufficient, substandard full reproducibility. main limitation want switch another Java environment, likely restart current R session set JAVA_HOME PATH environment variables desired Java environment using rJavaEnv::java_env_set(). done dynamically within R session due way Java initialized R, particularly rJava-dependent packages r5r. packages like opentripplanner, performs Java calls using command line, can switch Java environments dynamically within R session much want. Therefore, need use R packages depend different Java versions within project, create separate R scripts Java environment run separate R sessions. One effective way use callr package run R scripts separate R sessions. Another option use targets package manage whole project workflow, , side effect, lead R scripts run separate R sessions. use rJavaEnv targets, need download install several Java environments using rJavaEnv::java_download() rJavaEnv::java_install() set relevant path rJavaEnv::java_env_set() beginning function requires certain Java version.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"future-work","dir":"","previous_headings":"","what":"Future work","title":"rJavaEnv: Java Environments for R Projects","text":"future work includes: Add support Java distributions versions Take care R CMD javareconf Possibly add support specifying Java version beyond major version Possibly allow downloading several Java distributions one function call, e.g. different major versions ‘flavour’ different ‘flavours’ major version Possibly add automation get Java required specific Java-dependent R packages open suggestions contributions, welcome issues pull requests.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"acknowledgements","dir":"","previous_headings":"","what":"Acknowledgements","title":"rJavaEnv: Java Environments for R Projects","text":"thank rOpenSci Dev Guide, well Hadley Wickham Jennifer Bryan R Packages book. Package hex sticker logo partially generated DALL-E OpenAI. logo also contains original R logo.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/index.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"rJavaEnv: Java Environments for R Projects","text":"cite package ‘rJavaEnv’ publications use: Kotov E (2024). rJavaEnv: Java Environments R Projects. https://github.com/e-kotov/rJavaEnv. BibTeX:","code":"@Manual{rjavaenv, title = {rJavaEnv: Java Environments for R Projects}, author = {Egor Kotov}, year = {2024}, url = {https://github.com/e-kotov/rJavaEnv}, }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":null,"dir":"Reference","previous_headings":"","what":"Check installed Java version using terminal commands — java_check_version_cmd","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"Check installed Java version using terminal commands","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"","code":"java_check_version_cmd(java_home = NULL)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"java_home Path Java home directory. NULL, function uses JAVA_HOME environment variable.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"TRUE successful, otherwise FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_cmd.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check installed Java version using terminal commands — java_check_version_cmd","text":"","code":"java_check_version_cmd() #> JAVA_HOME: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> Java path: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8/bin/java #> Java version: \"openjdk version \\\"1.8.0_412\\\" OpenJDK Runtime Environment #> Corretto-8.412.08.1 (build 1.8.0_412-b08) OpenJDK 64-Bit Server VM #> Corretto-8.412.08.1 (build 25.412-b08, mixed mode)\" #> [1] TRUE"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":null,"dir":"Reference","previous_headings":"","what":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"function sets JAVA_HOME environment variable, initializes JVM using rJava, prints Java version used user sets given JAVA_HOME current R session. check performed separate R session avoid reload current R session. reason Java initialized R session, uninitialized unless current R session restarted.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"","code":"java_check_version_rjava(java_home = NULL, verbose = TRUE)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"java_home path desired JAVA_HOME. NULL, uses current JAVA_HOME environment variable. verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"TRUE successful, otherwise FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_rjava.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check Java Version with a Specified JAVA_HOME Using a Separate R Session — java_check_version_rjava","text":"","code":"java_check_version_rjava() #> Using current session's JAVA_HOME: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> With the user-specified JAVA_HOME rJava and other rJava/Java-based packages #> will use Java version: \"1.8.0_412\" #> [1] TRUE"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_system.html","id":null,"dir":"Reference","previous_headings":"","what":"Check and print Java path and version — java_check_version_system","title":"Check and print Java path and version — java_check_version_system","text":"function checks Java executable path retrieves Java version, prints details console.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_system.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check and print Java path and version — java_check_version_system","text":"","code":"java_check_version_system()"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_check_version_system.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check and print Java path and version — java_check_version_system","text":"TRUE successful, otherwise FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":null,"dir":"Reference","previous_headings":"","what":"Manage Java installations and distributions caches — java_clear","title":"Manage Java installations and distributions caches — java_clear","text":"Wrapper function clear Java symlinked current project, installed, distributions caches.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Manage Java installations and distributions caches — java_clear","text":"","code":"java_clear( type = c(\"project\", \"installed\", \"distrib\"), target_dir = NULL, check = TRUE, delete_all = FALSE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Manage Java installations and distributions caches — java_clear","text":"type clear: \"project\" - remove symlinks install cache current project, \"installed\" - remove installed Java versions, \"distrib\" - remove downloaded Java distributions. target_dir directory clear. Defaults current working directory \"project\" user-specific data directory \"installed\" \"distrib\". recommended change. check Whether list contents cache directory clearing . Defaults TRUE. delete_all Whether delete items without prompting. Defaults FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Manage Java installations and distributions caches — java_clear","text":"message indicating whether cache cleared .","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Manage Java installations and distributions caches — java_clear","text":"","code":"java_clear(\"project\") #> Java symlink directory does not exist in the project. java_clear(\"installed\") #> Contents of the Java installations cache folder: #> ℹ Existing Java installations: #> 1: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/17 #> 2: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/21 #> 3: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> ℹ Enter the number of the installation to delete, 'all' to delete all, or '0' or any other character to cancel: #> No installations were cleared. java_clear(\"distrib\") #> ℹ Existing Java distributions: #> 1: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-17-aarch64-macos-jdk.tar.gz #> 2: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-21-aarch64-macos-jdk.tar.gz #> 3: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-22-aarch64-macos-jdk.tar.gz #> 4: #> /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-8-aarch64-macos-jdk.tar.gz #> ℹ Enter the number of the distribution to delete, 'all' to delete all, or '0' or any other character to cancel: #> No distributions were cleared."},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"Clear the Java distributions cache folder — java_clear_distrib_cache","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"Clear Java distributions cache folder","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"","code":"java_clear_distrib_cache( check = TRUE, delete_all = FALSE, cache_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\") )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"check Whether list contents cache directory clearing . Defaults TRUE. delete_all Whether delete distributions without prompting. Defaults FALSE. cache_dir cache directory clear. Defaults user-specific data directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"message indicating whether cache cleared .","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_distrib_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Clear the Java distributions cache folder — java_clear_distrib_cache","text":"","code":"if (FALSE) { java_clear_distrib_cache() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":null,"dir":"Reference","previous_headings":"","what":"Clear the Java versions symlinked in the current project — java_clear_in_project","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"Clear Java versions symlinked current project","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"","code":"java_clear_in_project(project_dir = getwd(), check = TRUE, delete_all = FALSE)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"project_dir project directory clear. Defaults current working directory. check Whether list symlinked Java versions clearing . Defaults TRUE. delete_all Whether delete symlinks without prompting. Defaults FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"message indicating whether symlinks cleared .","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_in_project.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Clear the Java versions symlinked in the current project — java_clear_in_project","text":"","code":"if (FALSE) { java_clear_in_project() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"Clear the Java installations cache folder — java_clear_installed_cache","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"Clear Java installations cache folder","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"","code":"java_clear_installed_cache( check = TRUE, delete_all = FALSE, cache_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\") )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"check Whether list contents cache directory clearing . Defaults TRUE. delete_all Whether delete installations without prompting. Defaults FALSE. cache_dir cache directory clear. Defaults user-specific data directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"message indicating whether cache cleared .","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_clear_installed_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Clear the Java installations cache folder — java_clear_installed_cache","text":"","code":"if (FALSE) { java_clear_installed_cache() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a Java distribution — java_download","title":"Download a Java distribution — java_download","text":"Download Java distribution","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a Java distribution — java_download","text":"","code":"java_download( version = 21, distribution = \"Corretto\", dest_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\"), platform = platform_detect()$os, arch = platform_detect()$arch, verbose = TRUE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a Java distribution — java_download","text":"version Java version download. specified, defaults latest LTS version. distribution Java distribution download. specified, defaults \"Corretto\". dest_dir destination directory download Java distribution . Defaults user-specific data directory. platform platform download Java distribution. Defaults current platform. arch architecture download Java distribution. Defaults current architecture. verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a Java distribution — java_download","text":"path downloaded Java distribution file.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_download.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download a Java distribution — java_download","text":"","code":"if (FALSE) { java_download(version = \"17\", distribution = \"Corretto\") java_download(distribution = \"Corretto\") java_download() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"Set JAVA_HOME PATH environment variables given path","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"","code":"java_env_set(java_home, where = c(\"both\", \"session\", \"project\"), verbose = T)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"java_home path desired JAVA_HOME. set JAVA_HOME: \"session\", \"project\", \"\". Defaults \"\". \"\" \"project\" selected, function updates .Rprofile file project directory set JAVA_HOME PATH environment variables start R session. verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"Nothing. Sets JAVA_HOME PATH environment variables.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the JAVA_HOME and PATH environment variables to a given path — java_env_set","text":"","code":"if (FALSE) { java_env_set(\"/path/to/java\", \"both\") }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_rprofile.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the .Rprofile file in the project directory — java_env_set_rprofile","title":"Update the .Rprofile file in the project directory — java_env_set_rprofile","text":"Update .Rprofile file project directory","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_rprofile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the .Rprofile file in the project directory — java_env_set_rprofile","text":"","code":"java_env_set_rprofile(java_home)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_rprofile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the .Rprofile file in the project directory — java_env_set_rprofile","text":"java_home path desired JAVA_HOME.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_session.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the JAVA_HOME and PATH environment variables for the current session — java_env_set_session","title":"Set the JAVA_HOME and PATH environment variables for the current session — java_env_set_session","text":"Set JAVA_HOME PATH environment variables current session","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_session.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the JAVA_HOME and PATH environment variables for the current session — java_env_set_session","text":"","code":"java_env_set_session(java_home)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_set_session.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the JAVA_HOME and PATH environment variables for the current session — java_env_set_session","text":"java_home path desired JAVA_HOME.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":null,"dir":"Reference","previous_headings":"","what":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"Unset JAVA_HOME PATH environment variables project .Rprofile","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"","code":"java_env_unset(verbose = TRUE)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"Nothing. Removes JAVA_HOME PATH environment variables settings project .Rprofile.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_env_unset.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Unset the JAVA_HOME and PATH environment variables in the project .Rprofile — java_env_unset","text":"","code":"if (FALSE) { java_env_unset() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":null,"dir":"Reference","previous_headings":"","what":"Install Java from a distribution file — java_install","title":"Install Java from a distribution file — java_install","text":"Install Java distribution file","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install Java from a distribution file — java_install","text":"","code":"java_install( java_path, project = NULL, autoset_java_path = TRUE, verbose = TRUE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install Java from a distribution file — java_install","text":"java_path path Java distribution file. project project directory Java installed. Defaults current working directory. autoset_java_path Whether set JAVA_HOME PATH environment variables installed Java directory. Defaults TRUE. verbose Whether print detailed messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Install Java from a distribution file — java_install","text":"path installed Java directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_install.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install Java from a distribution file — java_install","text":"","code":"if (FALSE) { java_install(\"path/to/any-java-17-aarch64-macos-jdk.tar.gz\") }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List the contents of the Java cache — java_list","title":"List the contents of the Java cache — java_list","text":"List contents Java cache","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List the contents of the Java cache — java_list","text":"","code":"java_list( type = c(\"project\", \"installed\", \"distrib\"), output = c(\"data.frame\", \"vector\"), verbose = FALSE, target_dir = NULL )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List the contents of the Java cache — java_list","text":"type type cache list: \"distrib\", \"installed\", \"project\". output format output: \"data.frame\" \"vector\". Defaults \"data.frame\". verbose Whether print detailed messages. Defaults FALSE. target_dir cache directory list. Defaults user-specific data directory \"distrib\" \"installed\", current working directory \"project\".","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List the contents of the Java cache — java_list","text":"data frame character vector contents specified cache directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List the contents of the Java cache — java_list","text":"","code":"java_list(\"project\") #> ✖ Project Java symlink directory does not exist #> character(0) java_list(\"installed\") #> path #> 1 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/17 #> 2 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/21 #> 3 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> platform arch version #> 1 macos aarch64 17 #> 2 macos aarch64 21 #> 3 macos aarch64 8 java_list(\"distrib\") #> java_distr_path #> 1 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-17-aarch64-macos-jdk.tar.gz #> 2 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-21-aarch64-macos-jdk.tar.gz #> 3 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-22-aarch64-macos-jdk.tar.gz #> 4 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-8-aarch64-macos-jdk.tar.gz"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"List the contents of the Java distributions cache folder — java_list_distrib_cache","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"List contents Java distributions cache folder","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"","code":"java_list_distrib_cache( output = c(\"data.frame\", \"vector\"), verbose = FALSE, cache_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\") )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"output format output: \"data.frame\" \"vector\". Defaults \"data.frame\". verbose Whether print detailed messages. Defaults FALSE. cache_dir cache directory list. Defaults user-specific data directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"character vector contents cache directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_distrib_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List the contents of the Java distributions cache folder — java_list_distrib_cache","text":"","code":"java_list_distrib_cache() #> java_distr_path #> 1 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-17-aarch64-macos-jdk.tar.gz #> 2 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-21-aarch64-macos-jdk.tar.gz #> 3 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-22-aarch64-macos-jdk.tar.gz #> 4 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/distrib/amazon-corretto-8-aarch64-macos-jdk.tar.gz"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":null,"dir":"Reference","previous_headings":"","what":"List the Java versions symlinked in the current project — java_list_in_project","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"List Java versions symlinked current project","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"","code":"java_list_in_project( project_dir = getwd(), output = c(\"data.frame\", \"vector\"), verbose = FALSE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"project_dir project directory list. Defaults current working directory. output format output: \"data.frame\" \"vector\". Defaults \"data.frame\". verbose Whether print detailed messages. Defaults FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"data frame character vector symlinked Java versions project directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_in_project.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List the Java versions symlinked in the current project — java_list_in_project","text":"","code":"java_list_in_project() #> ✖ Project Java symlink directory does not exist #> character(0)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"List the contents of the Java installations cache folder — java_list_installed_cache","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"List contents Java installations cache folder","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"","code":"java_list_installed_cache( output = c(\"data.frame\", \"vector\"), verbose = FALSE, cache_dir = tools::R_user_dir(\"rJavaEnv\", which = \"cache\") )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"output format output: \"data.frame\" \"vector\". Defaults \"data.frame\". verbose Whether print detailed messages. Defaults FALSE. cache_dir cache directory list. Defaults user-specific data directory. recommended change.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"data frame character vector contents cache directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_list_installed_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List the contents of the Java installations cache folder — java_list_installed_cache","text":"","code":"java_list_installed_cache() #> path #> 1 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/17 #> 2 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/21 #> 3 /Users/ek/Library/Caches/org.R-project.R/R/rJavaEnv/installed/macos/aarch64/8 #> platform arch version #> 1 macos aarch64 17 #> 2 macos aarch64 21 #> 3 macos aarch64 8"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":null,"dir":"Reference","previous_headings":"","what":"Download and install and set Java in current working/project directory — java_quick_install","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"Download install set Java current working/project directory","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"","code":"java_quick_install( version = 21, distribution = \"Corretto\", platform = platform_detect()$os, arch = platform_detect()$arch, verbose = TRUE )"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"version Java version download. specified, defaults latest LTS version. distribution Java distribution download. specified, defaults \"Corretto\". platform platform download Java distribution. Defaults current platform. arch architecture download Java distribution. Defaults current architecture. verbose Whether print messages. Defaults TRUE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"Message indicating Java installed set current working/project directory.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_quick_install.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download and install and set Java in current working/project directory — java_quick_install","text":"","code":"if (FALSE) { java_quick_install() }"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_urls_load.html","id":null,"dir":"Reference","previous_headings":"","what":"Load Java URLs from JSON file — java_urls_load","title":"Load Java URLs from JSON file — java_urls_load","text":"Load Java URLs JSON file","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_urls_load.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load Java URLs from JSON file — java_urls_load","text":"","code":"java_urls_load()"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_urls_load.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load Java URLs from JSON file — java_urls_load","text":"list Java URLs structured JSON file distribution, platform, architecture.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_version_check_rscript.html","id":null,"dir":"Reference","previous_headings":"","what":"Check Java version using rJava — java_version_check_rscript","title":"Check Java version using rJava — java_version_check_rscript","text":"Check Java version using rJava","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_version_check_rscript.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check Java version using rJava — java_version_check_rscript","text":"","code":"java_version_check_rscript(java_home)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_version_check_rscript.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check Java version using rJava — java_version_check_rscript","text":"java_home","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/java_version_check_rscript.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check Java version using rJava — java_version_check_rscript","text":"message Java version error message.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/platform_detect.html","id":null,"dir":"Reference","previous_headings":"","what":"Detect platform and architecture — platform_detect","title":"Detect platform and architecture — platform_detect","text":"Detect platform architecture","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/platform_detect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Detect platform and architecture — platform_detect","text":"","code":"platform_detect(verbose = FALSE)"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/platform_detect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Detect platform and architecture — platform_detect","text":"verbose Whether print detailed messages. Defaults FALSE.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/platform_detect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Detect platform and architecture — platform_detect","text":"list length 2 detected platform architecture.","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/rJavaEnv-package.html","id":null,"dir":"Reference","previous_headings":"","what":"rJavaEnv: Java Environments for R Projects — rJavaEnv-package","title":"rJavaEnv: Java Environments for R Projects — rJavaEnv-package","text":"Install specific version Java runtime environment R project level. goal rJavaEnv manage multiple Java JDKs R projects automatingthe process downloading, installing, configuring Java environments per-project basis. package inspired renv https://rstudio.github.io/renv/ package managing R environments R projects. can request specific Java Development Kit (JDK) project, rJavaEnv download install requested Java environment project-specific directory set PATH JAVA_HOME using project. Therefore, can different Java versions different projects without contaminating system different Java versions.","code":""},{"path":[]},{"path":"http://www.ekotov.pro/rJavaEnv/reference/rJavaEnv-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"rJavaEnv: Java Environments for R Projects — rJavaEnv-package","text":"Maintainer: Egor Kotov kotov.egor@gmail.com (ORCID) [copyright holder]","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/urls_test_all.html","id":null,"dir":"Reference","previous_headings":"","what":"Test all Java URLs — urls_test_all","title":"Test all Java URLs — urls_test_all","text":"Test Java URLs","code":""},{"path":"http://www.ekotov.pro/rJavaEnv/reference/urls_test_all.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Test all Java URLs — urls_test_all","text":"","code":"urls_test_all()"},{"path":"http://www.ekotov.pro/rJavaEnv/reference/urls_test_all.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Test all Java URLs — urls_test_all","text":"list results testing Java URLs.","code":""},{"path":[]},{"path":"http://www.ekotov.pro/rJavaEnv/news/index.html","id":"initial-release-0-0-1","dir":"Changelog","previous_headings":"","what":"Initial release","title":"version 0.0.1","text":"Initial release","code":""},{"path":[]},{"path":"http://www.ekotov.pro/rJavaEnv/news/index.html","id":"newsmd-setup-0-0-0-9000","dir":"Changelog","previous_headings":"","what":"NEWS.md setup","title":"version 0.0.0.9000","text":"added NEWS.md creation newsmd","code":""}]