FLQuantPoint: Class FLQuantPoint

In flr/FLCore: Core Package of FLR, Fisheries Modelling in R

Class FLQuantPoint

Description

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

Usage

FLQuantPoint(object, ...)

## S4 method for signature 'missing'
FLQuantPoint(..., units = "NA", n = 1)

## S4 method for signature 'FLQuant'
FLQuantPoint(object, ..., probs = c(0.25, 0.75))

## S4 method for signature 'FLQuantPoint'
n(object, ...)

Arguments

object	Input numeric object
...	Additonal arguments

Details

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.

Accesors

mean,mean<-:

'mean' element on 6th dimension, arithmetic mean.

median,median<-:

'median' element on 6th dimension, median.

var,var<-:

'var' element on 6th dimension, variance.

lowq,lowq<-:

'lowq' element on 6th dimension, lower quantile (0.25 by default).

uppq,uppq<-:

'uppq' element on 6th dimension, upper quantile (0.75 by default).

quantile:

returns the 'lowq' or 'uppq' iter, depending on the value of 'probs' (0.25 or 0.75).

Constructor

Inputs can be of class:

FLQuant:

An FLQuant object with iters (i.e. dim6 > 1)

Validity

iter:

iter dimension is of length 5.

Dimnames:

iter dimnames are 'mean', 'median', 'var', 'uppq' and'lowq'

Author(s)

The FLR Team

See Also

FLQuant

Examples

flq <- FLQuant(rlnorm(2000), dim=c(10,20,1,1,1,200), units="kg")
flqp <- FLQuantPoint(flq)
flqp <- FLQuantPoint(flq, probs=c(0.05, 0.95))
summary(flqp)
mean(flqp)
var(flqp)
rnorm(200, flqp)

flr/FLCore documentation built on May 4, 2024, midnight