Run Gompitz Predicion

Run Gompitz Predicion

Usage

runGompitzPrediction(
  input.data,
  subset = NULL,
  calibration,
  strategy = 0,
  ...,
  verbose = 1,
  do.stop = TRUE,
  clear.observations = TRUE,
  VERSION = getOperatingSystemType(),
  use.data.table = getOption("kwbGompitz.use.data.table", FALSE)
)

Arguments

input.data

prepared input data as retrieved by composeGompitzInputData

subset

indexes of rows in input.data to be used for prediction. if NULL, all rows in input.data will be used.

calibration

result of Gompitz calibration as retrieved by runGompitzCalibration

strategy

strategy identifier. Must be one of 0 (do nothing), 1 (length-driven strategy), 2 (budget-driven strategy), or 3 (optimised strategy).")

...

arguments passed to the corresponding .fileContentStrategy functions, such as range.years (two-element vector with first and last year of prediction), rehabilitation.costs (needed for strategy = 1 or 2 or 3, see kwbGompitz:::.fileContentStrategy1 or kwb.gomiptz:::.fileContentStrategy2 or kwb.gomiptz:::.fileContentStrategy3), annual.total.length (needed for strategy = 1, see kwbGompitz:::.fileContentStrategy1), annual.total.budget (needed for strategy = 2, see kwb.gomiptz:::.fileContentStrategy2), max.tol.prop.of.length (needed for strategy = 3, see kwb.gomiptz:::.fileContentStrategy3), target.year (needed for strategy = 3, see kwb.gomiptz:::.fileContentStrategy3)

verbose

verbosity level, default: 1

do.stop

if TRUE the program stops in case of inconsistencies

clear.observations

if TRUE (default) the columns containing the inspection year and the observed condition class, respectively, are cleared in the input file given to gompred. Otherwise the observed condition classes are kept in the input file and thus considered by gompred.

VERSION

name of subdirectory in package containing the binary files to be executed. Possible values: "unix", "win32", "win32_kwb"

use.data.table

if TRUE, fread is used to read the result file

Examples

# For an example, see the Tutorial vignette "How to Use the Package"