Skip to content

Commit

Permalink
Description formating and CRAN badge
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexDo1 committed Nov 28, 2022
1 parent bac25a9 commit 11d15c3
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ knitr::opts_chunk$set(
<!-- badges: start -->
[![R-CMD-check](https://github.com/VForWaTer/json2aRgs/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/VForWaTer/json2aRgs/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/github/VForWaTer/json2aRgs/branch/main/graph/badge.svg?token=aHZ4sfqKGj)](https://codecov.io/github/VForWaTer/json2aRgs)
[![CRAN status](https://www.r-pkg.org/badges/version/json2aRgs)](https://CRAN.R-project.org/package=json2aRgs)
<!-- badges: end -->

## Parse Parameters Inside a Docker Container (tool)
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

[![R-CMD-check](https://github.com/VForWaTer/json2aRgs/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/VForWaTer/json2aRgs/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/github/VForWaTer/json2aRgs/branch/main/graph/badge.svg?token=aHZ4sfqKGj)](https://codecov.io/github/VForWaTer/json2aRgs)
[![CRAN
status](https://www.r-pkg.org/badges/version/json2aRgs)](https://CRAN.R-project.org/package=json2aRgs)
<!-- badges: end -->

## Parse Parameters Inside a Docker Container (tool)
Expand Down

0 comments on commit 11d15c3

Please sign in to comment.