FLQuantPoint-class: Class FLQuantPoint

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

Description

The FLQuantPoint class summarizes the contents of an FLQuant object with multiple iterations along its sixth dimension using a number of descriptive statistics.

An object of this class has a set structure along its sixth dimension (iter), which will always be of length 5, and with dimnames mean, median, var, uppq and lowq. They refer, respectively, to the sample mean, sample median, variance, and lower (0.25) and upper (0.75) quantiles.

Objects of this class wil be typically created from an FLQuant. The various statistics are calculated along the iter dimension of the original FLQuant using apply.

Slots

.Data

The main array holding the computed statistics. array.

units

Units of measurement. character.

Extends

FLQuant array

Constructor

Objects of class FLQuantPoint can be created using this method, applied to an object of class FLQuant with length two or more along its sixth dimension (iter).

signature(object=FLQuant) :

Describe method

Methods

lowq(FLCore) :

Accesor for lowq iteration

signature(x=FLQuantPoint)

lowq<-(FLCore) :

Modifies the lowq iteration

signature(x=FLQuantPoint,value=FLQuant)

mean(base) :

Accesor for mean iteration

signature(x=FLQuantPoint)

mean<-(FLCore) :

Modifies the mean iteration

signature(x=FLQuantPoint,value=FLQuant)

median(stats) :

Accesor for median iteration

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

median<-(FLCore) :

Modifies the median iteration

signature(x=FLQuantPoint,value=FLQuant)

plot(graphics) :

Plot an object of the class

signature(x=FLQuantPoint,y=missing)

quantile(stats) :

Accesor for lowq or uppq iteration

signature(x=FLQuantPoint)

rlnorm(stats) :

Creates a lognormally-distributed FLQuant using the information on an FLQuantPoint

signature(n=numeric,meanlog=FLQuantPoint,sdlog=missing)

rnorm(stats) :

Creates a normally-distributed FLQuant using the information on an FLQuantPoint

signature(n=numeric,mean=FLQuantPoint,sd=missing)

show(methods) :

Outputs object in screen

signature(object=FLQuantPoint)

summary(base) :

Prints a summary of the object

signature(object=FLQuantPoint)

uppq(FLCore) :

Accesor for uppq iteration

signature(x=FLQuantPoint)

uppq<-(FLCore) :

Modifies the uppq iteration

signature(x=FLQuantPoint,value=FLQuant)

var(stats) :

Accesor for var iteration

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

var<-(FLCore) :

Modifies the var iteration

signature(x=FLQuantPoint,value=FLQuant)

Author(s)

The FLR Team

See Also

lowq, lowq<-, mean, mean<-, median, median<-, plot, quantile, rlnorm, rnorm, show, summary, uppq, uppq<-, var, var<-, FLQuant, array

Examples

flq <- FLQuant(rnorm(2000), dim=c(10,20,1,1,1,200))
flqp <- FLQuantPoint(flq)
summary(flqp)
mean(flqp)
var(flqp)
rnorm(200, flqp)

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