FLPar-class: Class FLPar

In FLCore: Core package of FLR, fisheries modelling in R.

Description

The FLPar class is a class for storing the parameters of a model. It is based on the array class which can store Monte Carlo samples and the names of the relevant parameter vectors.

Methods for this class include subsetting and replacement as they exist for the FLQuant class. There are methods for extracting statistics of the sample (mean, median etc.) and for plotting the parameter samples.

Slots

.Data

Describe slot. array.

units

Units of measurement. character.

Extends

array

Constructor

The FLPar(object) constructor method allows simple creation of new FLPar with the methods described below.

signature(object=array) :

Describe method

signature(object=missing) :

Describe method

signature(object=vector) :

Describe method

Methods

[(base) :

Subsetting method to access the parameter values.

signature(x=FLPar,i=ANY,j=ANY,drop=missing)

[<-(base) :

Replacement method for the parameter values.

signature(x=FLPar,i=ANY,j=ANY,value=missing)

as.data.frame(base) :

Creates a data frame from the object.

signature(x=FLPar,row.names=ANY,optional=ANY)

densityplot(lattice) :

applies the densityplot method from lattice

signature(x=formula,data=FLPar)

histogram(lattice) :

applies the histogram method from lattice

signature(x=formula,data=FLPar)

iter(FLCore) :

extracts the relevant iteration for the given parameter sample.

signature(object=missing)

iter<-(FLCore) :

replacement method for the parameter iteration.

signature(object=missing,value=missing)

mean(base) :

calculates the mean of the parameter samples.

signature(x=missing)

median(stats) :

calculates the median of the parameter samples.

signature(x=missing,na.rm=missing)

plot(graphics) :

default plot method for FLPar

signature(x=FLPar,y=missing)

splom(lattice) :

applies the splom method from lattice

signature(x=FLPar,data=missing)

summary(base) :

Summarises the FLPar object.

signature(object=missing)

units(base) :

extracts the units of the parameters.

signature(x=missing)

units<-(base) :

replacement method for the units of the object.

signature(x=FLPar,value=character)

var(stats) :

calculates the variance of the parameter samples.

signature(x=missing,y=missing,na.rm=missing,use=missing)

Author(s)

The FLR Team

See Also

[, [<-, as.data.frame, densityplot, histogram, iter, iter<-, mean, median, plot, splom, summary, units,FLPar-method, units<-,FLPar,character-method, var

Examples

FLPar(rnorm(4), params=c('a','b','c','sigma2'))

FLCore documentation built on May 2, 2019, 5:46 p.m.