run_ExeFile: Run an MND simulation using the simulator.exe file.

View source: R/run_ExeFile.R

run_ExeFileR Documentation

Run an MND simulation using the simulator.exe file.

Description

run_ExeFile reads the simulator path to the executable file of the simulator of mobile network event data and the input file parameters to execute the simulator.exe from this path.

If the executable file doesn't exist, the function will donwload it automatically from the Assests section of this URL in github.com (for version 1.2.0):

https://github.com/bogdanoancea/simulator/releases/tag/1.2.0

The name of the executable file is simulator.exe.

For Windows, the user can download an installer from the URL (for version 1.2.0):

https://github.com/bogdanoancea/simulator/releases/tag/1.2.0-kit

Usage

run_ExeFile(
  path_to_exe,
  simulator_version,
  input_folder,
  simulationCFGFile,
  mapFile,
  personsCFGFile,
  antennasCFGFile
)

Arguments

path_to_exe

character vector with the absolute path to the executable file of the simulator of mobile network event data.

simulator_version

character denoting the version of the simulator (e.g. "1.2.0")

input_folder

absolute path where the simulation input files are.

simulationCFGFile

name of the configuration simulation file (input file).

mapFile

name of the map file (input file).

personsCFGFile

name of the persons file (input file).

antennasCFGFile

name of the antennas file (input file).

Details

Return invisible NULL after placing output files of the simulation in the output folder.

Examples

## Not run: 
# simulator.exe will be downloaded from our github repo
run_ExeFile(
  path_to_exe       = "",
  simulator_version = "1.2.0",
  input_folder      = file.path(rootPath, "extdata/input_files"),
  simulationCFGFile = "simulation.xml",
  mapFile           = "map.wkt",
  personsCFGFile    = "persons.xml",
  antennasCFGFile   = "antennas.xml"
)

## End(Not run)


bogdanoancea/simutils documentation built on April 4, 2022, 2:58 p.m.