model: model object constructor.

View source: R/class_model.R

modelR Documentation

model object constructor.

Description

Creates a new instance of a 'model' object

Usage

model(
  fname = "Config_Model.txt",
  ID = "Linear",
  nX = 1,
  nY = 1,
  par = list(parameter("Xeffect", 1, prior.dist = "FlatPrior")),
  xtra = xtraModelInfo()
)

Arguments

fname

Character, configuration file name.

ID

Character, model ID. Type 'getCatalogue()' for available models.

nX

Integer, number of input variables.

nY

Integer, number of output variables.

par

list of parameter objects, parameters of the model.

xtra

xtraModelInfo object.

Value

An object of class 'model'.

Examples

# defaut linear regression model Y=aX+b
mod <- model()
# BaRatin model for a single-control rating curve Y=a(X-b)^c
mod <- model(ID='BaRatin',nX=1,nY=1,
             par=list(parameter('a',10,prior.dist='LogNormal',prior.par=c(log(10),0.1)),
                      parameter('b',-1,prior.dist='Gaussian',prior.par=c(-1,1)),
                      parameter('c',5/3,prior.dist='Gaussian',prior.par=c(5/3,0.05))),
             xtra=xtraModelInfo(object=matrix(1,nrow=1,ncol=1)))

BaM-tools/RBaM documentation built on April 11, 2025, 10:01 p.m.