SticsRFiles

The goal of SticsRFiles is to perform manipulations of the Stics model files either on XML files (used by the JavaStics GUI) or on text files used by the model fortran executable.

The basic functionnalites allows to read parameters names and values through XML queries and replace parameters values in files. A starting guide is available on the Get started page.

Advanced functionnalities are dedicated to produce XML parameter files using a mailing process like from XML templates and Excel sheets containing multiple simulations contexts. A JavaStics workspace is generated and directly usable from the JavaStics interface (GUI or command line), or with an R JavaStics interface provided by the SticsOnR package.

Prerequisites and technical tips

Some information about software requirements and operating system constraints are given in the SticsOnR package documentation here.

Installation

---

Warning: If during the installation process, packages updates are suggested.

• First, abort the installation.
• Second, update the installed packages, except the XML package.
• Finally, install the SticsRFiles package.

---

Recommended installation: SticsRPacks

The best way to install the packages from SticsRPacks, from which SticsRFiles is part of, is by installing the [SticsRPacks] package. The package can be installed from GitHub using either the devtools package, or the more lightweight remotes package:

devtools::install_github("SticsRPacks/SticsRPacks")

• With remotes

# install.packages("remotes")
remotes::install_github("SticsRPacks/SticsRPacks")

The package will install the packages for you at the last release version.

Or, install directly

• With devtools

devtools::install_github("SticsRPacks/SticsRFiles@*release")

• With remotes

# install.packages("remotes")
remotes::install_github("SticsRPacks/SticsRFiles@*release")

Normaly, all the package dependencies will be installed for CRAN packages.

Examples

Files manipulations

• A description of how to use the functions for manipulating XML input files is detailed here

• A description of how to use the functions for manipulating text input files is available here.

Files generation

• A description of mailing functions usefull for generating XML input files from usms parameters data stored in Excel files sheets will be available soon.

• A description of functions for generating text input files from XML one of usms parameters is available here.

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

The package is under intensive development, so you can fill an issue or request us a feature here at any time.

Authors and acknowledgments

The SticsRFiles package is developed by Patrice Lecharpentier, Rémi Vezy and the SticsRFiles Team.