runModel: Minimalistic generic model interface

In dkneis/diatools: Utilities for Diagenetic Modeling

Description

Wrapper function to run an arbitrarily complex model using a minimalistic interface.

Usage

runModel(model, input, outdir)

Arguments

model	Function representing the model. It is called as model(input, outdir).
input	List with model inputs. See below for expected contents.
outdir	Name of an existing directory where any output files created by model should be stored. Do not assume that model cares/warns for existing files in outdir.

Value

The return value of model.

Note

The following columns are mandatory in data frame input:

• name : Denotes an input item of the model. Typically it is a parameter, a variable, or a dimension constant (character string).

• value : Value of the input item (numeric).

• label : Short, human-readable label for the input item (character string). Can be used, e.g., in graphics produced by the model. Example: For a variable with name 'NO3', the label could be 'Nitrate (mg/l)'.

Author(s)

David Kneis [e-mail]

Examples

# This model does no computations, it only creates a html table of its inputs
input= list(tbl=data.frame(name=c("a","b"), value=1:2))
model= function(input, outdir) {
  html= paste0("<table border=1>\n  <tr><th> ",paste(names(input$tbl),
    collapse=paste0(" </th><th> "))," </th></tr>\n")
  for (i in 1:nrow(input$tbl)) {
    html= paste0(html,"  <tr>",paste0("<td style='text-align:right'> ",
      unlist(input$tbl[i,])," </td>",collapse=""),"</tr>\n")
  }
  html= paste0(html,"</table>\n")
  write(file=paste(outdir,"out.html",sep="/"), x=html)
  return(invisible(NULL))
}
outdir=tempdir()
runModel(model=model, input=input, outdir=outdir)

dkneis/diatools documentation built on May 15, 2019, 9:12 a.m.