FLMetiers-class: Class FLMetiers

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

Description

FLMetiers is a class that extends list through FLlst but implements a set of features that give a little bit more structure to list objects. The elements of FLMetiers must all be of class FLMetier. It implements a lock mechanism that, when turned on, does not allow the user to increase or decrease the object length.

Slots

.Data

The data. list.

names

Names of the list elements. character.

desc

Description of the object. character.

lock

Lock mechanism, if turned on the length of the list can not be modified by adding or removing elements. logical.

Extends

FLlst list vector

Constructor

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

signature(object=ANY) :

create a FLMetiers object from a set of FLMetier objects

signature(object=missing) :

create a FLMetiers object as a void list for future use

signature(object=list) :

create a FLMetiers object from a list of FLMetier objects

Methods

catch(FLCore) :

Accessor method getting the FLCatch catch slots. Returns a FLQuants

signature(object=missing)

catch.n(FLCore) :

Accessor method getting the FLCatch catch.n slots. Returns a FLQuants

signature(object=missing)

catch.wt(FLCore) :

Accessor method getting the FLCatch catch.wt slots. Returns a FLQuants

signature(object=missing)

discards(FLCore) :

Accessor method getting the FLCatch discards slots. Returns a FLQuants

signature(object=missing)

discards.n(FLCore) :

Accessor method getting the FLCatch discards.n slots. Returns a FLQuants

signature(object=missing)

discards.wt(FLCore) :

Accessor method getting the FLCatch discards.wt slots. Returns a FLQuants

signature(object=missing)

landings(FLCore) :

Accessor method getting the FLCatch landings slots. Returns a FLQuants

signature(object=missing)

landings.n(FLCore) :

Accessor method getting the FLCatch landings.n slots. Returns a FLQuants

signature(object=missing)

landings.wt(FLCore) :

Accessor method getting the FLCatch landings.wt slots. Returns a FLQuants

signature(object=missing)

catch.q(FLCore) :

Accessor method getting the FLCatch catch.q slots. Returns a FLQuants

signature(object=missing)

price(FLCore) :

Accessor method getting the FLCatch price slots. Returns a FLQuants

signature(object=missing)

Author(s)

The FLR Team

See Also

catch, catch.n, catch.wt, discards, discards.n, discards.wt, FLFleet, landings, landings.n, landings.wt, price, FLlst, list

Examples

# creation
met1 <- FLMetier(name='met1',catches=FLCatches(FLCatch(name="spp1",
  landings.n=FLQuant(rnorm(100), dim=c(10,20)))))
met2 <- FLMetier(name='met2',catches=FLCatches(FLCatch(name="spp1",
  landings.n=FLQuant(rnorm(100), dim=c(10,20))), FLCatch(name="spp2",
  landings.n=FLQuant(rnorm(100), dim=c(10,20)))))
lst.metiers <- FLMetiers(met1=met1,met2=met2)

# getter
landings.n(met1,catch="spp1") # get a FLQuant
landings.n(lst.metiers,catch="spp1") # get a FLQuants across metiers
landings.n(lst.metiers,metier="met1") # get a FLQuants across species
landings.n(lst.metiers,metier="met1",catch="spp1") # get a FLQuant

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