Skip to content

Commit 71548ec

Browse files
committed
version bump and meta update
1 parent 3d34e6c commit 71548ec

File tree

7 files changed

+64
-19
lines changed

7 files changed

+64
-19
lines changed

CITATION.cff

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ message: 'To cite package "rJavaEnv" in publications use:'
88
type: software
99
license: MIT
1010
title: 'rJavaEnv: ''Java'' Environments for R Projects'
11-
version: 0.1.2
11+
version: 0.2.0
1212
doi: 10.32614/CRAN.package.rJavaEnv
1313
abstract: 'Solve common issues with ''Java'' environment management in ''R'' for users
1414
of ''Java''/''rJava''-dependent ''R'' packages such as ''r5r'', ''opentripplanner'',
@@ -56,6 +56,17 @@ keywords:
5656
- reproducibility
5757
- reproducible-research
5858
references:
59+
- type: software
60+
title: 'R: A Language and Environment for Statistical Computing'
61+
notes: Depends
62+
url: https://www.R-project.org/
63+
authors:
64+
- name: R Core Team
65+
institution:
66+
name: R Foundation for Statistical Computing
67+
address: Vienna, Austria
68+
year: '2024'
69+
version: '>= 4.0'
5970
- type: software
6071
title: checkmate
6172
abstract: 'checkmate: Fast and Versatile Argument Checks'

DESCRIPTION

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: rJavaEnv
22
Title: 'Java' Environments for R Projects
3-
Version: 0.1.2
3+
Version: 0.2.0
44
Authors@R: c(
55
person("Egor", "Kotov", , "[email protected]", role = c("aut", "cre", "cph"),
66
comment = c(ORCID = "0000-0001-6690-5345")),
@@ -28,6 +28,8 @@ Description: Solve common issues with 'Java' environment management in 'R'
2828
License: MIT + file LICENSE
2929
URL: https://github.com/e-kotov/rJavaEnv, https://www.ekotov.pro/rJavaEnv/
3030
BugReports: https://github.com/e-kotov/rJavaEnv/issues
31+
Depends:
32+
R (>= 4.0)
3133
Imports:
3234
checkmate,
3335
cli,
@@ -45,5 +47,3 @@ Encoding: UTF-8
4547
Language: en-US
4648
Roxygen: list(markdown = TRUE)
4749
RoxygenNote: 7.3.2
48-
Depends:
49-
R (>= 4.0)

NEWS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# rJavaEnv 0.1.3 (2024-08-28)
1+
# rJavaEnv 0.2.0 (2024-08-28)
22

33
* Breaking change: `java_check_version_cmd()` and `java_check_version_rjava()` now return detected `Java` version instead of `TRUE`/`FALSE`
44

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ alt="CRAN/METACRAN Total downloads" /></a>
2323
<!-- [![pkgcheck](https://github.com/e-kotov/rJavaEnv/workflows/pkgcheck/badge.svg)](https://github.com/e-kotov/rJavaEnv/actions?query=workflow%3Apkgcheck) -->
2424
[![codecov](https://codecov.io/github/e-kotov/rJavaEnv/graph/badge.svg?token=2UKGZVNO5V)](https://app.codecov.io/github/e-kotov/rJavaEnv)
2525

26-
[![DOI](https://zenodo.org/badge/DOI/10.32614/CRAN.package.rJavaEnv.svg)](https://doi.org/10.32614/CRAN.package.rJavaEnvi)
26+
[![DOI](https://zenodo.org/badge/DOI/10.32614/CRAN.package.rJavaEnv.svg)](https://doi.org/10.32614/CRAN.package.rJavaEnv)
2727
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11403009.svg)](https://doi.org/10.5281/zenodo.11403009)
2828

2929
<!-- badges: end -->
3030

3131
Solve common issues with `Java` environment management in `R` for users
3232
of `Java`/`{rJava}`-dependent `R` packages such as `{r5r}`,
3333
`{opentripplanner}`, `{xlsx}`, `{openNLP}`, `{rWeka}`, `{RJDBC}`,
34-
`{tabulapdf}`, and many more. `{rJavaENv}` prevents common problems like
34+
`{tabulapdf}`, and many more. `{rJavaEnv}` prevents common problems like
3535
`Java` not found, `Java` version conflicts, missing `Java`
3636
installations, and the inability to install `Java` due to lack of
3737
administrative privileges. `rJavaEnv` automates the download,
@@ -124,10 +124,32 @@ Just insert this line into the begining of any script that you run with
124124
rJavaEnv::use_java("21")
125125
```
126126

127+
This acts exactly like `java_quick_install()`, but only sets the
128+
environment variables in the current session and does not copy or link
129+
`Java` binaries into the project directory.
130+
127131
More details are in the vignette [Multiple `Java` environments in one
128132
project with `targets` and
129133
`callr`](https://www.ekotov.pro/rJavaEnv/articles/multiple-java-with-targets-callr.qmd).
130134

135+
## Cleanup
136+
137+
If you do not want to use `rJavaEnv` anymore, please clear the cache
138+
folders before removing the package:
139+
140+
``` r
141+
java_clear("project", delete_all = TRUE)
142+
java_clear("installed", delete_all = TRUE)
143+
java_clear("distrib", delete_all = TRUE)
144+
```
145+
146+
Also, clear the `.Rprofile` file in the projects there you used the
147+
package:
148+
149+
``` r
150+
java_env_unset()
151+
```
152+
131153
## Functions Overview
132154

133155
The package has several core functions:
@@ -166,6 +188,12 @@ The package has several core functions:
166188
9. `java_clear()`
167189
- Removes all or some `Java` versions linked in the current project
168190
(or cached distributions or installations).
191+
10. `use_java()`
192+
193+
- Same as `java_quick_install()`, but in a less intrusive way. Does not
194+
copy or link the `Java` installation folder from cache into the
195+
project directory and does not create or edit your `.Rprofile` file.
196+
Only sets requested java in the current R session.
169197

170198
See more details on all the functions in the
171199
<a href="https://www.ekotov.pro/rJavaEnv/reference/index.html"

README.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ is_html <- knitr::is_html_output()
2929
<!-- [![pkgcheck](https://github.com/e-kotov/rJavaEnv/workflows/pkgcheck/badge.svg)](https://github.com/e-kotov/rJavaEnv/actions?query=workflow%3Apkgcheck) -->
3030
[![codecov](https://codecov.io/github/e-kotov/rJavaEnv/graph/badge.svg?token=2UKGZVNO5V)](https://app.codecov.io/github/e-kotov/rJavaEnv)
3131

32-
[![DOI](https://zenodo.org/badge/DOI/10.32614/CRAN.package.rJavaEnv.svg)](https://doi.org/10.32614/CRAN.package.rJavaEnvi)
32+
[![DOI](https://zenodo.org/badge/DOI/10.32614/CRAN.package.rJavaEnv.svg)](https://doi.org/10.32614/CRAN.package.rJavaEnv)
3333
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11403009.svg)](https://doi.org/10.5281/zenodo.11403009)
3434

3535
<!-- badges: end -->
3636

37-
Solve common issues with `Java` environment management in `R` for users of `Java`/`{rJava}`-dependent `R` packages such as `{r5r}`, `{opentripplanner}`, `{xlsx}`, `{openNLP}`, `{rWeka}`, `{RJDBC}`, `{tabulapdf}`, and many more. `{rJavaENv}` prevents common problems like `Java` not found, `Java` version conflicts, missing `Java` installations, and the inability to install `Java` due to lack of administrative privileges. `rJavaEnv` automates the download, installation, and setup of the `Java Development Kit` (`JDK`) on a per-project basis by setting the relevant `JAVA_HOME` in the current `R` session or the current working directory (via `.Rprofile`, with the user's consent). Similar to what `renv` does for `R` packages, `rJavaEnv` allows different `Java` versions to be used across different projects, but can also be configured to allow multiple versions within the same project (e.g. with the help of `{targets}` package). **Note: there are a few extra steps for 'Linux' users, who don't have any 'Java' previously installed in their system, and who prefer package installation from source, rather then installing binaries from 'Posit Package Manager'. See [documentation](https://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html#note-linux) for details.**
37+
Solve common issues with `Java` environment management in `R` for users of `Java`/`{rJava}`-dependent `R` packages such as `{r5r}`, `{opentripplanner}`, `{xlsx}`, `{openNLP}`, `{rWeka}`, `{RJDBC}`, `{tabulapdf}`, and many more. `{rJavaEnv}` prevents common problems like `Java` not found, `Java` version conflicts, missing `Java` installations, and the inability to install `Java` due to lack of administrative privileges. `rJavaEnv` automates the download, installation, and setup of the `Java Development Kit` (`JDK`) on a per-project basis by setting the relevant `JAVA_HOME` in the current `R` session or the current working directory (via `.Rprofile`, with the user's consent). Similar to what `renv` does for `R` packages, `rJavaEnv` allows different `Java` versions to be used across different projects, but can also be configured to allow multiple versions within the same project (e.g. with the help of `{targets}` package). **Note: there are a few extra steps for 'Linux' users, who don't have any 'Java' previously installed in their system, and who prefer package installation from source, rather then installing binaries from 'Posit Package Manager'. See [documentation](https://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html#note-linux) for details.**
3838

3939

4040

@@ -112,15 +112,15 @@ More details are in the vignette [Multiple `Java` environments in one project wi
112112

113113
If you do not want to use `rJavaEnv` anymore, please clear the cache folders before removing the package:
114114

115-
```{r}
115+
```r
116116
java_clear("project", delete_all = TRUE)
117117
java_clear("installed", delete_all = TRUE)
118118
java_clear("distrib", delete_all = TRUE)
119119
```
120120

121121
Also, clear the `.Rprofile` file in the projects there you used the package:
122122

123-
```{r}
123+
```r
124124
java_env_unset()
125125
```
126126

codemeta.json

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
"identifier": "rJavaEnv",
55
"description": "Solve common issues with 'Java' environment management in 'R' for users of 'Java'/'rJava'-dependent 'R' packages such as 'r5r', 'opentripplanner', 'xlsx', 'openNLP', 'rWeka', 'RJDBC', 'tabulapdf', and many more. `rJavaEnv` prevents common problems like 'Java' not found, 'Java' version conflicts, missing 'Java' installations, and the inability to install 'Java' due to lack of administrative privileges. 'rJavaEnv' automates the download, installation, and setup of the 'Java Development Kit' ('JDK') on a per-project basis by setting the relevant 'JAVA_HOME' in the current 'R' session or the current working directory (via '.Rprofile', with the user's consent). Similar to what 'renv' does for 'R' packages, 'rJavaEnv' allows different 'Java' versions to be used across different projects, but can also be configured to allow multiple versions within the same project (e.g. with the help of 'targets' package). Note: there are a few extra steps for 'Linux' users, who don't have any 'Java' previously installed in their system, and who prefer package installation from source, rather then installing binaries from 'Posit Package Manager'. See documentation for details.",
66
"name": "rJavaEnv: 'Java' Environments for R Projects",
7-
"relatedLink": ["https://www.ekotov.pro/rJavaEnv/", "https://CRAN.R-project.org/package=rJavaEnv"],
7+
"relatedLink": "https://www.ekotov.pro/rJavaEnv/",
88
"codeRepository": "https://github.com/e-kotov/rJavaEnv",
99
"issueTracker": "https://github.com/e-kotov/rJavaEnv/issues",
1010
"license": "https://spdx.org/licenses/MIT",
11-
"version": "0.1.2",
11+
"version": "0.2.0",
1212
"programmingLanguage": {
1313
"@type": "ComputerLanguage",
1414
"name": "R",
@@ -98,6 +98,12 @@
9898
],
9999
"softwareRequirements": {
100100
"1": {
101+
"@type": "SoftwareApplication",
102+
"identifier": "R",
103+
"name": "R",
104+
"version": ">= 4.0"
105+
},
106+
"2": {
101107
"@type": "SoftwareApplication",
102108
"identifier": "checkmate",
103109
"name": "checkmate",
@@ -109,7 +115,7 @@
109115
},
110116
"sameAs": "https://CRAN.R-project.org/package=checkmate"
111117
},
112-
"2": {
118+
"3": {
113119
"@type": "SoftwareApplication",
114120
"identifier": "cli",
115121
"name": "cli",
@@ -121,7 +127,7 @@
121127
},
122128
"sameAs": "https://CRAN.R-project.org/package=cli"
123129
},
124-
"3": {
130+
"4": {
125131
"@type": "SoftwareApplication",
126132
"identifier": "curl",
127133
"name": "curl",
@@ -133,7 +139,7 @@
133139
},
134140
"sameAs": "https://CRAN.R-project.org/package=curl"
135141
},
136-
"4": {
142+
"5": {
137143
"@type": "SoftwareApplication",
138144
"identifier": "jsonlite",
139145
"name": "jsonlite",
@@ -145,14 +151,14 @@
145151
},
146152
"sameAs": "https://CRAN.R-project.org/package=jsonlite"
147153
},
148-
"5": {
154+
"6": {
149155
"@type": "SoftwareApplication",
150156
"identifier": "utils",
151157
"name": "utils"
152158
},
153159
"SystemRequirements": null
154160
},
155-
"fileSize": "381.063KB",
161+
"fileSize": "528.471KB",
156162
"citation": [
157163
{
158164
"@type": "SoftwareSourceCode",

inst/schemaorg.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"url": "https://cran.r-project.org"
3737
},
3838
"runtimePlatform": "R version 4.4.1 (2024-06-14)",
39-
"version": "0.1.2"
39+
"version": "0.2.0"
4040
},
4141
{
4242
"id": "https://doi.org/10.32614/CRAN.package.rJavaEnv",

0 commit comments

Comments
 (0)