Welcome to the documentation of the SticsRPacks project.
- A general overview - a brief, general overview of the developing workflow and tools used in the project and where to find them.
- The
sandbox- an example project to introduce step by step all the tools described in theSticsRPacksdocumentation with use cases. The users can clone this project and use the tools. It is strongly recommanded to read the documents in this project before doing anything. - The reviewing process - a tutorial on how to review other contributors changes.
- The coding style - the coding style guide for our project.
- The optimum data structures - evaluation of different data structures such as
data.frame,data.table,tibble,list, multi-dimensionalarraysfor their performance (memory, execution time, ease of use) in read/write, selection, computation, etc... - The procedure to deprecate functions or arguments
- The procedure for CRAN (re-)submission
- The checklist to control before releasing new versions of the packages
- Technical information about CI/CD
Each package has its own documentation living in its repository or website. The website of each package can be found at: https://sticsrpacks.github.io/{packagename}/. For example the website for the sandbox project is located here: https://sticsrpacks.github.io/sandbox/
The sandbox repository is an R package that was specifically created to help new people to learn the basis of all tools used in the project. It is strongly advised to read the documents from this project before starting anything.
The SticsRFiles package was designed read and write the input and output files for STICS either for the xml files or directly for the text files (e.g. ficplt.txt or var.mod).
The SticsOnR package was designed to control STICS from R e.g. create USMs and simulations instances, run the STICS model, extract the raw results, etc...
A package for parameter estimation, uncertainty / sensitivity analysis for the STICS model using R.