+[{"path":"https://kwb-r.github.io/kwb.raindrop/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Michael Rustler. Author, maintainer. RAINDROP. Funder. . Copyright holder.","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Rustler M (2025). kwb.raindrop: R Package Optimisation Simulations Rainwater Management Simulations Performed Calculation Engine Provided Tandler. R package version 0.0.0.9000, https://github.com/KWB-R/kwb.raindrop.","code":"@Manual{, title = {kwb.raindrop: R Package for Optimisation Simulations for Rainwater Management Simulations Performed with Calculation Engine Provided by Tandler}, author = {Michael Rustler}, year = {2025}, note = {R package version 0.0.0.9000}, url = {https://github.com/KWB-R/kwb.raindrop}, }"},{"path":"https://kwb-r.github.io/kwb.raindrop/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"R Package for Optimisation Simulations for Rainwater Management Simulations Performed with Calculation Engine Provided by Tandler","text":"details install KWB-R packages checkout installation tutorial.","code":"### Optionally: specify GitHub Personal Access Token (GITHUB_PAT) ### See here why this might be important for you: ### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat # Sys.setenv(GITHUB_PAT = \"mysecret_access_token\") # Install package \"remotes\" from CRAN if (! require(\"remotes\")) { install.packages(\"remotes\", repos = \"https://cloud.r-project.org\") } # Install KWB package 'kwb.raindrop' from GitHub remotes::install_github(\"KWB-R/kwb.raindrop\")"},{"path":"https://kwb-r.github.io/kwb.raindrop/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2025 Kompetenzzentrum Wasser Berlin gGmbH (KWB) Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::%>% details.","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/pipe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pipe operator — %>%","text":"lhs value magrittr placeholder. rhs function call using magrittr semantics.","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/pipe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pipe operator — %>%","text":"result calling rhs(lhs).","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/run_model.html","id":null,"dir":"Reference","previous_headings":"","what":"Run an rainwater management model executable with an input file — run_model","title":"Run an rainwater management model executable with an input file — run_model","text":"Builds runs system command form \"<path_exe> <path_input>\", normalising paths absolute paths. Progress (optionally) command output wrapped kwb.utils::catAndRun() neat logging.","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/run_model.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run an rainwater management model executable with an input file — run_model","text":"","code":"run_model(path_exe, path_input, print_output = FALSE, debug = TRUE, ...)"},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/run_model.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run an rainwater management model executable with an input file — run_model","text":"path_exe character(1) Path model executable (e.g., .exe Windows). file must exist. path_input character(1) Path model input file passed single argument executable. file must exist. print_output logical(1) TRUE, stream process output console return exit status (integer). FALSE (default), capture return command output character vector. debug logical(1) Forwarded kwb.utils::catAndRun(dbg = ...) enable/disable progress message. Default: TRUE. ... Additional arguments passed base::shell(), e.g. timeout Windows. See ?base::shell details.","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/run_model.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run an rainwater management model executable with an input file — run_model","text":"print_output = FALSE, character vector containing captured standard output command. print_output = TRUE, (invisible) integer exit status returned shell() (0 indicates success).","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/run_model.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Run an rainwater management model executable with an input file — run_model","text":"path_exe path_input converted absolute, normalised paths via fs::path_abs() base::normalizePath(). command executed base::shell(), Windows invokes system shell. non-Windows platforms, prefer base::system() need full POSIX semantics.","code":""},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/run_model.html","id":"side-effects","dir":"Reference","previous_headings":"","what":"Side effects","title":"Run an rainwater management model executable with an input file — run_model","text":"Executes external program may read/write files depending model. Ensure trust executable paths provided.","code":""},{"path":[]},{"path":"https://kwb-r.github.io/kwb.raindrop/reference/run_model.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Run an rainwater management model executable with an input file — run_model","text":"","code":"if (FALSE) { # \\dontrun{ # Example: run a hypothetical model with an input file exe <- \"C:/path/to/model.exe\" input <- \"C:/path/to/input.h5\" # Capture output as character vector out <- run_model(exe, input, print_output = FALSE) # Stream output and get exit status status <- run_model(exe, input, print_output = TRUE) } # }"},{"path":"https://kwb-r.github.io/kwb.raindrop/news/index.html","id":"kwbraindrop-0009000","dir":"Changelog","previous_headings":"","what":"kwb.raindrop 0.0.0.9000","title":"kwb.raindrop 0.0.0.9000","text":"Added NEWS.md file track changes package. see https://style.tidyverse.org/news.html writing good NEWS.md","code":""}]
0 commit comments