This package allows to load, parameterize, run and analyze OpenFLUID simulations from the GNU R environment
The ROpenFLUID license is available in the package/LICENSE file
This package uses the following R packages:
- Runit (for tests only)
- roxygen2 (during package development only, not for installation or usage)
Package heavily relies on binding facilities provided by the OpenFLUID Framework.
See openfluid/utils/Binding.hpp and related headers in the OpenFLUID source code.
The R part of the code is written following the Tidyverse coding style, with the following exceptions:
- line length is not stricly limited to 80 characters and can be extended to 120 characters if needed
- case style of functions names is not restricted to the recommended snake case
The ROpenFLUID package requires for building process:
- The OpenFLUID framework
- The R development framework
- The CMake build tools family, version 3.1 or higher
- The GCC compiler version 5.3 or higher (for C++14 compatibility)
The build/doc commands are launched using the CMake tool in script mode. In this mode,
configuration variables passed on the command line must be placed before the -P <script> argument.
Each following command produces results in a build directory.
The default name for this directory is _build and is located at the root of the ROpenFLUID sources.
To override this default build directory, you can set a custom absolute path through the BUILD_PATH variable of the CMake command (e.g. cmake -DBUILD_PATH=/path/to/build/dir -P check.cmake)
On Windows platforms, the commands below have to be run in an MSYS2 terminal, using the mingw64 toolchain.
See the msys2-mingw64-env.sh.tpl file for configuration of the build environment.
This will run the R checking process for the package:
cmake -P check.cmake
The CRAN mode can be enabled to apply the CRAN submission requirements during the checking process:
cmake -DAS_CRAN_MODE=ON -P check.cmake
This will create the package:
cmake -P build.cmake
cmake -P htmldoc.cmake