diff --git a/DESCRIPTION b/DESCRIPTION index 2307e8a..a3b1670 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Package: rconfig Type: Package Title: Manage R Configuration at the Command Line Version: 0.1.3 -Date: 2022-04-26 +Date: 2022-06-22 Authors@R: c( person(given = "Peter", family = "Solymos", diff --git a/README.Rmd b/README.Rmd index 9954ffe..d06a176 100644 --- a/README.Rmd +++ b/README.Rmd @@ -252,7 +252,7 @@ sudo cp ./inst/examples/commands.R /usr/local/bin/ sudo chmod +x /usr/local/bin/commands.R ``` -Make sure that the R script has the 'shebang' (`#!/usr/bin/env Rscript`) as the 1st line, and now can drop the `Rscript` part and use the script as `commands.R model`. +Make sure that the R script has the shebang (`#!/usr/bin/env Rscript`) as the 1st line, and now can drop the `Rscript` part and use the script as `commands.R model`. ### Shiny diff --git a/README.md b/README.md index 20eb5cf..b2e3f7c 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,9 @@ The rconfig package has the following features: - nested configurations can also be flattened - command line flags without a value will evaluate to `TRUE`, e.g. `--verbose` +- differentiates verb/noun syntax, where verbs are sub-commands + following the R script file name and preceding the command line + flags (starting with `-` or `--`) This looks very similar to what [litter](https://CRAN.R-project.org/package=littler), @@ -397,7 +400,7 @@ Rscript iris.R --species virginica ``` bash Rscript iris.R --species setosa --verbose -# 2022-06-12 20:27:47 - Started +# 2022-06-22 10:37:53 - Started # Getting summaries for species setosa # Sepal.Length Sepal.Width Petal.Length Petal.Width # Min. :4.300 Min. :2.300 Min. :1.000 Min. :0.100 @@ -406,12 +409,12 @@ Rscript iris.R --species setosa --verbose # Mean :5.006 Mean :3.428 Mean :1.462 Mean :0.246 # 3rd Qu.:5.200 3rd Qu.:3.675 3rd Qu.:1.575 3rd Qu.:0.300 # Max. :5.800 Max. :4.400 Max. :1.900 Max. :0.600 -# 2022-06-12 20:27:47 - Done +# 2022-06-22 10:37:53 - Done ``` ``` bash Rscript iris.R --species maxima --verbose -# 2022-06-12 20:27:47 - Started +# 2022-06-22 10:37:53 - Started # Error: Provide a valid species # Execution halted ``` @@ -438,15 +441,15 @@ Rscript mtcars.R ``` bash Rscript mtcars.R --verbose --vars cyl -# 2022-06-12 20:27:48 - Started +# 2022-06-22 10:37:54 - Started # (Intercept) cyl # 37.88458 -2.87579 -# 2022-06-12 20:27:48 - Done +# 2022-06-22 10:37:54 - Done ``` ``` bash Rscript mtcars.R --verbose --vars cal -# 2022-06-12 20:27:48 - Started +# 2022-06-22 10:37:54 - Started # Error: Not valid variable # Execution halted ``` @@ -489,7 +492,7 @@ sudo cp ./inst/examples/commands.R /usr/local/bin/ sudo chmod +x /usr/local/bin/commands.R ``` -Make sure that the R script has the ‘shebang’ (`#!/usr/bin/env Rscript`) +Make sure that the R script has the shebang (`#!/usr/bin/env Rscript`) as the 1st line, and now can drop the `Rscript` part and use the script as `commands.R model`. diff --git a/_pkgdown.yml b/_pkgdown.yml index 21bf549..073e11e 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,7 +1,26 @@ +url: https://hub.analythium.io/rconfig + +home: + title: "rconfig: Manage R Configuration at the Command Line" + description: | + Configuration management using files (JSON, YAML, separated text), + JSON strings, and command line arguments. + template: bootstrap: 5 includes: - in_header: + in_header: | + + + opengraph: + image: + src: https://hub.analythium.io/assets/web/rconfig.png + alt: "rconfig: Manage R Configuration at the Command Line" + twitter: + creator: "@psolymos" + site: "@analythium" + card: summary_large_image + navbar: structure: right: [search, twitter, github] @@ -14,3 +33,4 @@ navbar: icon: fa-github href: http://github.com/analythium aria-label: GitHub +