ScalePar {HYPEtools}

Scale 'par.txt' files to different model time step

Description

ScalePar scales time step-dependent parameters in an imported HYPE 'par.txt' parameter file to a new target time step.

Usage

ScalePar(x, sfac = 1/24, digits = 3, verbose = TRUE, print.par = FALSE)

Arguments

x

List containing HYPE parameters. Typically imported with ReadPar().

sfac

Numeric, scale factor. Defaults to scaling from daily to hourly time steps.

digits

Integer, number of significant digits in SLC class columns to export. See signif().

verbose

Logical, if TRUE, then information will be printed.

print.par

Logical, print known time-scale dependent parameters instead of scaling a par list.

Details

ScalePar simply applies a user-chosen scaling factor sfac to all time scale-dependent parameters in a HYPE parameter list. Parameters are matched against an inbuilt set of parameter names. Please notify us if you find parameters missing.

Value

A list() object as supplied in x, with parameters re-scaled parameters, or nothing if print.par = TRUE.

Examples

# Import daily HYPE parameter file
hpar <- ReadPar(filename = system.file("demo_model", "par.txt", package = "HYPEtools"))
# Scale to hourly time steps
ScalePar(x = hpar)
# Print all time scale-dependent parameters known to the function
ScalePar(print.par = TRUE)