Skip to content

Commit

Permalink
desctiption and meta fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
e-kotov committed Sep 3, 2024
1 parent d80372a commit 63a3909
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 41 deletions.
32 changes: 17 additions & 15 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,23 @@ license: MIT
title: 'rJavaEnv: ''Java'' Environments for R Projects'
version: 0.2.0
doi: 10.32614/CRAN.package.rJavaEnv
abstract: '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.'
abstract: 'Quickly install ''Java Development Kit (JDK)'' without administrative proviliges
and set environment variables in current R session or project to solve common issues
with ''Java'' environment management in ''R''. Recommended to 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'' 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.'
authors:
- family-names: Kotov
given-names: Egor
Expand Down
38 changes: 20 additions & 18 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,26 @@ Authors@R: c(
person("Hadley", "Wickham", , "[email protected]", role = "ctb",
comment = "use_java feature suggestion and PR review")
)
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.
Description: Quickly install 'Java Development Kit (JDK)' without
administrative proviliges and set environment variables in current R
session or project to solve common issues with 'Java' environment
management in 'R'. Recommended to 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' 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.
License: MIT + file LICENSE
URL: https://github.com/e-kotov/rJavaEnv, https://www.ekotov.pro/rJavaEnv/
BugReports: https://github.com/e-kotov/rJavaEnv/issues
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ alt="CRAN/METACRAN Downloads per month" /></a>

<!-- badges: end -->

Solve common issues with `Java` environment management in `R` for users
Quickly install ‘Java’ SDK without administrative proviliges and set
environment variables in current R session or project to solve common
issues with ‘Java’ environment management in ‘R’. Recommended to users
of `Java`/`{rJava}`-dependent `R` packages such as `{r5r}`,
`{opentripplanner}`, `{xlsx}`, `{openNLP}`, `{rWeka}`, `{RJDBC}`,
`{tabulapdf}`, and many more. `{rJavaEnv}` prevents common problems like
Expand Down
2 changes: 1 addition & 1 deletion README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ is_html <- knitr::is_html_output()

<!-- badges: end -->

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.**
Quickly install `Java Development Kit (JDK)` without administrative proviliges and set environment variables in current R session or project to solve common issues with 'Java' environment management in 'R'. Recommended to 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` 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.**



Expand Down
4 changes: 2 additions & 2 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "rJavaEnv",
"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.",
"description": "Quickly install 'Java Development Kit (JDK)' without administrative proviliges and set environment variables in current R session or project to solve common issues with 'Java' environment management in 'R'. Recommended to 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' 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.",
"name": "rJavaEnv: 'Java' Environments for R Projects",
"relatedLink": "https://www.ekotov.pro/rJavaEnv/",
"codeRepository": "https://github.com/e-kotov/rJavaEnv",
Expand Down Expand Up @@ -164,7 +164,7 @@
},
"SystemRequirements": null
},
"fileSize": "528.71KB",
"fileSize": "529.823KB",
"citation": [
{
"@type": "SoftwareSourceCode",
Expand Down
4 changes: 2 additions & 2 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Update to 0.2.0

Brings new functions based on very quick user feedback after the first release.
Also, hopefully, new safeguarding eval=false in vignette will prevent erros on macos-oldrel https://cran.r-project.org/web/checks/check_results_rJavaEnv.html when vignette code is executed.
Also, hopefully, the new safeguarding with 'eval=false' in vignette will prevent erros on macos-oldrel https://cran.r-project.org/web/checks/check_results_rJavaEnv.html when vignette code is executed, even though the whole vignette is set no to evaluate the code.

# rJavaEnv 0.2.0 (2024-08-28)

* Breaking change: `java_check_version_cmd()` and `java_check_version_rjava()` now return detected `Java` version instead of `TRUE`/`FALSE`
* Improvement: `java_check_version_cmd()` and `java_check_version_rjava()` now return detected `Java` version instead of `TRUE`/`FALSE`. Note that this is a breaking change, but not critical given that the package has not obtained a significant user base yet.

* New function `use_java()` to download, install and set `Java` from cache for the current sesssion, without touching the current project/working directory. This is intended for use with `targets` and `callr`.

Expand Down
2 changes: 1 addition & 1 deletion inst/schemaorg.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"familyName": "Kotov",
"givenName": "Egor"
},
"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.",
"description": "Quickly install 'Java Development Kit (JDK)' without administrative proviliges and set environment variables in current R session or project to solve common issues with 'Java' environment management in 'R'. Recommended to 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' 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.",
"license": "https://spdx.org/licenses/MIT",
"name": "rJavaEnv: 'Java' Environments for R Projects",
"programmingLanguage": {
Expand Down
2 changes: 1 addition & 1 deletion man/rJavaEnv-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 63a3909

Please sign in to comment.