check.IN: Function to check a CHILD input file for

In coffeemuggler/RCHILD: Functions for flexible use of the landscape evolution model CHILD

Description

This function checks an S4-object IN for consistency. It can work consistency. (detected issues noticed) or active (detected issues changed) mode. A list of in passive detected issues is returned. Not assgined (empty) and unused parameters are checked.

Usage

check.IN(IN, mode)

Arguments

IN	(character scalar) Name of the S4-object that will be checked.
mode	(logical) Mode of how to deal with detected issues: active (issues will be changed) as far as possible) or passive (issues will be reported only), default is passive.

Details

This function is primarily designed for two reasons: i) to identify and potentially adjust common errors in the input-file prior to run CHILD and ii) to remove uncessary parameters from the input-file. Although CHILD reports some errors in the input-file, treating errors directly in R allows for automatic error-handling rather than user- interaction with printed error or warning messages.
The function is of preliminary stage, yet. So far, only the presence of mandatory parameters ist checked and potentially corrected, i.e. assigned with dummy values from some of the example input-files from the CSDMS website. PLEASE HELP AND REPORT MISSING FUNCTIONALITY AND BUGS TO THE MAINTAINER!

Value

A list object

IN	S4-object with the (potentially modified) input-file
warnings	Character matrix with warnings
notifications	Character matrix with notes

Author(s)

Michael Dietze

References

CSDMS website. http://csdms.colorado.edu/wiki/Model:CHILD.
Tucker, GE. 2010. CHILD Users Guide for version R9.4.1. http://csdms.colorado.edu/mediawiki/images/Child_users_guide.pdf
Tucker, GE., Lancaster, ST., Gasparini, NM., Bras, RL. 2001. The Channel-Hillslope Integrated Landscape Development (CHILD) Model. In Harmon, RS., Doe, W.W. III (eds). Landscape Erosion and Evolution Modeling. Kluwer Academic/Plenum Publishers, pp. 349-388.

See Also

write.IN, read.IN, create.IN

Examples

# load example data set
data(hillslope1.in)

# check inputfile in active mode
check <- check.IN(hillslope1.in, mode = "active")

# extract checked and corrected IN-object
hillslope1c.in <- check$IN

# show warnings report
check$warnings

coffeemuggler/RCHILD documentation built on Dec. 31, 2020, 10:05 p.m.