Description Usage Arguments Author(s) Examples
This function needs to be executed in order to initiate a FloodMapper model run. A unique run name should be specified to identify the model run.
1 2 3 |
runname |
a unique name to identify the model run. A folder with this name will be created under your current work directory. |
startdatetime |
start datetime of the model run, should be formated as "YYYY-MM-DD hh:mm:ss". E.g., "2016-06-09 12:00:00". |
enddatetime |
end datetime of the model run, should be formated as "YYYY-MM-DD hh:mm:ss". E.g., "2016-06-09 13:00:00". |
outputinterval |
time step for the model outputs, unit: seconds. |
internaltimestep |
(OPTIONAL) internal integral time step, unit: seconds, default: 30 seconds. |
debug |
(OPTIONAL) if the debug mode is enabled, a log file (named log.txt) will be generated under the run folder. |
rerun |
(OPTIONAL) assign TRUE if this is a rerun. |
wdbreakpoints |
(OPTIONAL) a vector defines how to display the flood depth with different colors (unit: mm). This setting will be only applied to the outputted PNG/PDF files. |
workdir |
Full path to a user-specified work directory. If not specified, the temporary folder defined by tempdir() will be used. |
Xander Wang <xiuquan.wang@gmail.com>
1 2 3 4 5 | ## Load FloodMapper package
library(FloodMapper)
## Refer to Step 1 in the sample code of FM.start():
## Step 1. Initiate a new model run with a name of "Lafayette_1km"
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.