parameterFile <- system.file("extdata", "parameterlist.txt", package = "kwb.wtaq")
parameterInfo <- read.table(parameterFile, header = TRUE, sep="@", quote = "", 
                            fill = TRUE, stringsAsFactors=FALSE)
parameterInfo <- kwb.utils::hsRenameColumns(
  parameterInfo, 
  list(FunctionName = "Function", 
       ParameterName = "Parameter", 
       DefaultValue = "Default value"))

parameterInfo$Function <- kwb.utils::hsTrim(parameterInfo$Function)

printFunctionTable <- function(parameterInfo, functionName) {
  caption <- paste("Parameters with their default value and a description ",
                    "for the function `kwb.wtaq::", functionName, "`", sep = "")
  knitr::kable(
    parameterInfo[parameterInfo$Function == functionName, -1], 
    row.names = FALSE,
    caption = caption)
}

General settings

printFunctionTable(parameterInfo, "wtConfigureGeneral")

Aquifer settings

printFunctionTable(parameterInfo, "wtConfigureAquifer")

Drainage settings

printFunctionTable(parameterInfo, "wtConfigureDrainage")

Time settings

printFunctionTable(parameterInfo, "wtConfigureTimes")

Solver settings

printFunctionTable(parameterInfo, "wtConfigureSolution")

Pumping well settings

printFunctionTable(parameterInfo, "wtConfigurePumpwell")

Observation well settings

printFunctionTable(parameterInfo, "wtConfigureObservationWell")


KWB-R/kwb.wtaq documentation built on June 17, 2022, 3:05 a.m.