flowbased-path | R Documentation |
A flow-based "model" consists of the description of the typical domains (the weights, the second members and an RDS object containing additional information such as the vertices coordinates and the errors) and the time series file establishing the chronology of typical days used in an Antares study. These functions enable to choose the flow-based input folder: one can either use existing models stored in the package or use his own.
The function getAvailableModel
provides a list of the existing models.
The function setFlowbasedPath
sets the flow-based input folder.
It can either be one of the models listed by
getAvailableModel
or a path to a personal folder. This folder will then
be used as default parameter for all
functions of the package
The function fbOptions
indicates the current default path.
setFlowbasedPath(path, model) fbOptions() getAvailableModel()
path |
(optional) If the argument "model" is missing. Path to the flow-based input directory, it can be created by the user with the functions computeFB and createFBTS. The directory must be composed of:
|
model |
(optional)
If "path" is missing. Name of the chosen existing model
(Use |
A vector of available models for getAvailableModel
.
path of the current input repository, for setFlowbasedPath
and fbOptions
## Not run: # Get the default path used when loading the package fbOptions() # Specify an available model getAvailableModel() setFlowbasedPath(model = "antaresInputVirtualFBarea") # Specify a path # Change the model path for the path of a model you have on your computer setFlowbasedPath(path = system.file("testdata/antaresInput", package = "fbAntares")) # Specify a personnal model # Change the model name for the name of a model you have on your computer setFlowbasedPath(model = "mymodel") ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.