R Interface to OpenFLUID Platform Framework for Modelling and Simulation of Landscapes
Package for using OpenFLUID within the GNU R environment

Documentation for package ‘ROpenFLUID’ version 2.1.3-20160707

Help Pages

OpenFLUID.addExtraObserversPaths Adds paths to search for observers
OpenFLUID.addExtraSimulatorsPaths Adds paths to search for simulators
OpenFLUID.addVariablesExportAsCSV Adds export of simulation variables as CSV files for a given units class
OpenFLUID.createAttribute Creates an attribute for all spatial units of a class, initialized with a default value
OpenFLUID.getAttribute Returns an attribute value for a given spatial unit
OpenFLUID.getDefaultDeltaT Returns the simulation time step
OpenFLUID.getExtraObserversPaths Returns the added paths to search for observers
OpenFLUID.getExtraSimulatorsPaths Returns the added paths to search for simulators
OpenFLUID.getGeneratorParam Returns a generator parameter value
OpenFLUID.getModelGlobalParam Returns a model global parameter value
OpenFLUID.getObserverParam Returns an observer parameter value
OpenFLUID.getObserversPaths Returns the paths to search for observers
OpenFLUID.getPeriodBeginDate Returns the simulation period begin date
OpenFLUID.getPeriodEndDate Returns the simulation period end date
OpenFLUID.getSimulatorParam Returns a simulator parameter value
OpenFLUID.getSimulatorsPaths Returns the paths to search for simulators
OpenFLUID.getUnitsClasses Returns the existing units classes
OpenFLUID.getUnitsIDs Returns the existing units IDs for a given units class
OpenFLUID.getVersion Returns the OpenFLUID version
OpenFLUID.loadResult Loads results as a dataframe, giving dataset informations
OpenFLUID.loadResultFile Loads results as a dataframe, giving output file name
OpenFLUID.openDataset Opens a dataset and returns a simulation definition blob
OpenFLUID.openProject Opens a project and returns a simulation definition blob
OpenFLUID.printSimulationInfo Prints informations to screen about simulation definition blob
OpenFLUID.removeAttribute Removes an attribute value for a given spatial unit
OpenFLUID.removeModelGlobalParam Removes a model global parameter value
OpenFLUID.removeObserverParam Removes a observer parameter
OpenFLUID.removeSimulatorParam Removes a simulator parameter
OpenFLUID.resetExtraObserversPaths Resets list of added paths to search for observers
OpenFLUID.resetExtraSimulatorsPaths Resets list of added paths to search for simulators
OpenFLUID.runProject Runs a project and returns a simulation definition blob
OpenFLUID.runSimulation Runs a simulation from a simulation definition blob
OpenFLUID.setAttribute Sets an attribute value for a given spatial unit
OpenFLUID.setCurrentOutputDir Sets the current output directory for simulations
OpenFLUID.setDefaultDeltaT Sets the simulation time step
OpenFLUID.setGeneratorParam Sets a generator parameter value
OpenFLUID.setModelGlobalParam Sets a model global parameter value
OpenFLUID.setObserverParam Sets an observer parameter value
OpenFLUID.setPeriodBeginDate Sets the simulation period begin date
OpenFLUID.setPeriodEndDate Sets the simulation period end date
OpenFLUID.setSimulatorParam Sets a simulator parameter value
ROpenFLUID R Interface to OpenFLUID Platform Framework for Modelling and Simulation of Landscapes