The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.

SticsRFiles

Project Status: Active – The project has reached a stable, usable state and is being actively developed. R build status Codecov test coverage DOI

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 functionalities 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 functionalities 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.

If you want to be notified when a new release of this package is made, you can tick the Releases box in the “Watch / Unwatch => Custom” menu at the top right of this page.

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.


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 the remotes package:

      devtools::install_github("SticsRPacks/SticsRPacks")
      remotes::install_github("SticsRPacks/SticsRPacks")

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

Direct installation from the CRAN or GitHub

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

      or 
      
      remotes::install_github("SticsRPacks/SticsRFiles@*release")

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

Examples

Files manipulations

Files generation

Getting help

If you have any question or suggestion or if you want to report a bug, please do it via the GitHub issues.

Thanks for that, this would greatly help us to improve this package.

Citation

If you have used this package for a study that led to a publication or report, please cite us. You can either use the citation tool from GitHub if you used the last version, or use citation("SticsRFiles") from R otherwise.

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.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.