v0.3.0 CRAN release

VForWaTer · Nov 24, 2022 · bac25a9 · bac25a9
1 parent bc3a28c
commit bac25a9
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 25 deletions.
diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
@@ -0,0 +1,3 @@
+Version: 0.2.0
+Date: 2022-11-18 09:40:15 UTC
+SHA: e22e7f86f58269caab324fe386b39556ff72449a
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -5,7 +5,7 @@ Version: 0.3.0
 Authors@R: c(
     person("Alexander", "Dolich", email = "alexander.dolich@kit.edu", role = c("cre","aut")),
     person("Mirko", "Mälicke", email = "mirko.maelicke@kit.edu", role = "aut"))
-Description: The function get_parameters() is intended to be used within a docker container to read keyword arguments from a .json file automagically. A tool.yaml file contains specifications on these keyword arguments, which are then passed as input to containerized R tools in the [tool-runner framework](https://github.com/hydrocode-de/tool-runner). A template for a containerized R tool, which can be used as a basis for developing new tools, is available at the following URL: https://github.com/VForWaTer/tool_template_r.
+Description: The function get_parameters() is intended to be used within a docker container to read keyword arguments from a .json file automagically. A tool.yaml file contains specifications on these keyword arguments, which are then passed as input to containerized R tools in the [tool-runner framework](<https://github.com/hydrocode-de/tool-runner>). A template for a containerized R tool, which can be used as a basis for developing new tools, is available at the following URL: <https://github.com/VForWaTer/tool_template_r>.
 License: GPL-3
 URL: https://github.com/VForWaTer/json2aRgs
 BugReports: https://github.com/VForWaTer/json2aRgs/issues

diff --git a/README.Rmd b/README.Rmd
@@ -20,7 +20,11 @@ knitr::opts_chunk$set(
 [![codecov](https://codecov.io/github/VForWaTer/json2aRgs/branch/main/graph/badge.svg?token=aHZ4sfqKGj)](https://codecov.io/github/VForWaTer/json2aRgs)
 <!-- badges: end -->
 
-The function get_parameters() is intended to be used within a docker container to read keyword arguments from the file `/in/parameters.json` file automagically. The file `/src/tool.yaml` contains specifications on these keyword arguments, which are then passed as input to containerized R tools in the [tool-runner framework](https://github.com/hydrocode-de/tool-runner).
+## Parse Parameters Inside a Docker Container (tool)
+
+The function get_parameters() is intended to be used within a docker container with a certain file structure to read keyword arguments from the file `/in/parameters.json` automagically. 
+The file `/src/tool.yaml` contains specifications on these keyword arguments, which are then passed as input to containerized R tools in the [tool-runner framework](https://github.com/hydrocode-de/tool-runner).
+
 A template for a containerized R tool, which can be used as a basis for developing new tools, is available at the following URL: https://github.com/VForWaTer/tool_template_r.
 
 ## Installation

diff --git a/README.md b/README.md
@@ -9,14 +9,17 @@
 [![codecov](https://codecov.io/github/VForWaTer/json2aRgs/branch/main/graph/badge.svg?token=aHZ4sfqKGj)](https://codecov.io/github/VForWaTer/json2aRgs)
 <!-- badges: end -->
 
+## Parse Parameters Inside a Docker Container (tool)
+
 The function get_parameters() is intended to be used within a docker
-container to read keyword arguments from the file `/in/parameters.json`
-file automagically. The file `/src/tool.yaml` contains specifications on
-these keyword arguments, which are then passed as input to containerized
-R tools in the [tool-runner
-framework](https://github.com/hydrocode-de/tool-runner). A template for
-a containerized R tool, which can be used as a basis for developing new
-tools, is available at the following URL:
+container with a certain file structure to read keyword arguments from
+the file `/in/parameters.json` automagically. The file `/src/tool.yaml`
+contains specifications on these keyword arguments, which are then
+passed as input to containerized R tools in the [tool-runner
+framework](https://github.com/hydrocode-de/tool-runner).
+
+A template for a containerized R tool, which can be used as a basis for
+developing new tools, is available at the following URL:
 <https://github.com/VForWaTer/tool_template_r>.
 
 ## Installation

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,31 +1,29 @@
 ## R CMD check results
 
-For a CRAN submission we recommend that you fix all NOTEs, WARNINGs and ERRORs.
-## Test environments
-- R-hub windows-x86_64-devel (r-devel)
-- R-hub ubuntu-gcc-release (r-release)
-- R-hub fedora-clang-devel (r-devel)
-
-## R CMD check results
-❯ On windows-x86_64-devel (r-devel), ubuntu-gcc-release (r-release)
+❯ On ubuntu-gcc-release (r-release)
   checking CRAN incoming feasibility ... NOTE
-  Maintainer: 'Alexander Dolich <alexander.dolich@kit.edu>'
+  Maintainer: ‘Alexander Dolich <alexander.dolich@kit.edu>’
 
   New submission
-
-❯ On windows-x86_64-devel (r-devel)
-  checking for detritus in the temp directory ... NOTE
-  Found the following files/directories:
-    'lastMiKTeXException'
+  
+  Possibly misspelled words in DESCRIPTION:
+    automagically (8:137)
+    json (8:127)
+    yaml (8:159)
 
 ❯ On fedora-clang-devel (r-devel)
-  checking CRAN incoming feasibility ... [6s/26s] NOTE
+  checking CRAN incoming feasibility ... [6s/25s] NOTE
   Maintainer: ‘Alexander Dolich <alexander.dolich@kit.edu>’
 
   New submission
+
+  Possibly misspelled words in DESCRIPTION:
+    automagically (8:137)
+    json (8:127)
+    yaml (8:159)
 
 ❯ On fedora-clang-devel (r-devel)
   checking HTML version of manual ... NOTE
   Skipping checking HTML validation: no command 'tidy' found
 
-0 errors ✔ | 0 warnings ✔ | 4 notes ✖
+0 errors ✔ | 0 warnings ✔ | 3 notes ✖