![[OpenFLUID logo]](OpenFLUID_logo.png){kind=logo}
Package for using OpenFLUID within the GNU R environment
![[R logo]](R_logo.png){kind=logo}
Package for using OpenFLUID within the GNU R environment
| 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.deleteSimulationBlob | Delete simulation blob |
| OpenFLUID.getAttribute | Returns an attribute value for a given spatial unit |
| OpenFLUID.getAttributes | Returns the attributes values for given spatial units and attributes names |
| OpenFLUID.getAttributesNames | Returns all the attributes names of an units class |
| OpenFLUID.getDefaultDeltaT | Returns the default time step of the simulation |
| OpenFLUID.getExtraObserversPaths | Returns the added paths to search for observers |
| OpenFLUID.getExtraSimulatorsPaths | Returns the added paths to search for simulators |
| OpenFLUID.getGeneratorParam | Returns a the value of a generator parameter |
| OpenFLUID.getGeneratorParamNames | Returns all parameters names of a generator |
| OpenFLUID.getGeneratorParams | Returns the values of generator parameters |
| OpenFLUID.getGeneratorsVarNames | Returns all the variables names generated by generators |
| OpenFLUID.getModelGlobalParam | Returns the value of a global parameter of the model |
| OpenFLUID.getModelGlobalParamNames | Returns all the global parameters names |
| OpenFLUID.getModelGlobalParams | Returns the values of global parameters of the model |
| OpenFLUID.getObserverParam | Returns the value of an observer parameter |
| OpenFLUID.getObserverParamNames | Returns all parameters names of an observer |
| OpenFLUID.getObserverParams | Returns the values of observer parameters |
| OpenFLUID.getObserversIDs | Returns all observers IDs used for the monitoring |
| OpenFLUID.getObserversPaths | Returns all the paths to search for observers |
| OpenFLUID.getPeriodBeginDate | Returns the begin date of the simulation period |
| OpenFLUID.getPeriodEndDate | Returns the end date of the simulation period |
| OpenFLUID.getSimulatorParam | Returns the value of a simulator parameter |
| OpenFLUID.getSimulatorParamNames | Returns all the parameters names of a simulator |
| OpenFLUID.getSimulatorParams | Returns the values of simulator parameters |
| OpenFLUID.getSimulatorsIDs | Returns all the simulators IDs used by the model |
| OpenFLUID.getSimulatorsPaths | Returns all 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 the simulation definition blob |
| OpenFLUID.removeAttribute | Removes an attribute for a given spatial units class |
| OpenFLUID.removeModelGlobalParam | Removes a global parameter of the model |
| OpenFLUID.removeObserverParam | Removes an 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.runSimulationAsExternalProcess | Runs a simulation from a simulation definition blob as an external independent process |
| OpenFLUID.setAttribute | Sets an attribute value for a given spatial unit |
| OpenFLUID.setAttributes | Sets attributes values for given spatial units and attributes names |
| OpenFLUID.setCurrentOutputDir | Sets the current output directory for simulations |
| OpenFLUID.setDefaultDeltaT | Sets the default time step for the simulation |
| OpenFLUID.setGeneratorParam | Sets a value for a generator parameter |
| OpenFLUID.setGeneratorParams | Sets values of generator parameters |
| OpenFLUID.setModelGlobalParam | Sets a model global parameter value |
| OpenFLUID.setModelGlobalParams | Sets a value of a global parameter of the model |
| OpenFLUID.setObserverParam | Sets a value for an observer parameter |
| OpenFLUID.setObserverParams | Sets values for observer parameters |
| OpenFLUID.setPeriodBeginDate | Sets the begin date of the simulation period |
| OpenFLUID.setPeriodEndDate | Sets the end date of the simulation period |
| OpenFLUID.setSimulatorParam | Sets a value of a simulator parameter |
| OpenFLUID.setSimulatorParams | Sets values of a simulator parameters |
| OpenFLUID.writeDataset | Writes a dataset on disk from a simulation definition blob |
| ROpenFLUID | R Interface to OpenFLUID Platform Framework for Modelling and Simulation of Landscapes |