validLoadModelInterface: Test whether a class implements the loadModelInterface

View source: R/loadModelInterface.R

validLoadModelInterfaceR Documentation

Test whether a class implements the loadModelInterface

Description

validLoadModelInterface can be used to test whether the loadModelInterface has been successfully implemented for the class of a provided object.

Usage

validLoadModelInterface(object, stop.on.error = TRUE, verbose = TRUE)

Arguments

object

an object with a LoadModelInterface

stop.on.error

logical. If the interface is invalid, should the function throw an error (TRUE) or quietly return a warning object (FALSE)?

verbose

logical. turn on or off verbose messages.

Value

TRUE if interface for given load.model is well defined; otherwise, either throws an error (if stop.on.error=TRUE) or returns a vector of character strings describing the errors (if stop.on.error=FALSE).

See Also

Other loadModelInterface: estimateMSE, getFittedModel, getFittingData, getFittingFunction, getMetadata, predictSolute, simulateSolute, summarizeModel


USGS-R/loadflex documentation built on July 26, 2023, 9:54 p.m.