FLMetier-class: Class FLMetier

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

Description

The FLMetier class is an internal class of FLFleet storing all information related to the activity of a fleet in a specific metier. A metier refers typically to a particular type of activity described by e.g. a specific gear and/or mesh size range and/or target species and/or spatio-temporal distribution etc. The underlying use of the FLMetier class is to distinguish between several types of activities within the same fleet unit.

The FLMetier class can contain information about gear used, share of the effort of the fleet in that metier, variable costs, as well as catch information. Catches data are stored in a FLCatches object, which is a list of FLCatch objects. Each of them stores stock or species specific information such as landings, discards and catches, catchability and price.

A number of accessors are defined for FLMetier, allowing to extract directly specific slots both from the FLMetier class and to the FLCatch objects it contains. If catch is specified in those, it returns the FLQuant corresponding to the FLCatch object of that name. If catch is missing, it returns a FLQuants object for all stocks of the FLCatches object. Corresponding replacement methods for these slots exist for the FLQuant objects but not for the FLQuants objects, due to possible differences of dimensions across FLCatch objects.

Slots

gear

Name of the gear. character.

effshare

Proportion of the total effort of the fleet allocated to this metier. effshare must not be higher than 1, and the sums of effshare across all metiers within a fleet should be equal to or lower than 1. FLQuant.

vcost

Variable costs per unit of effort. FLQuant.

catches

List of FLCatch objects containing catch information by stock or species. FLCatches.

name

Name of the object. character.

desc

Description of the object. character.

range

(numeric) Named vector containing the dimensions of the object

Extends

FLComp

Constructor

The FLMetier constructor method allows creation of new FLMetier objects from either a FLQuant, a FLCatch or a FLCatches object.

signature(catches=FLCatch) :

Creates a FLMetier object from a FLCatch object.

signature(catches=FLCatches) :

Creates a FLMetier object from a FLCatches object.

signature(catches=FLQuant) :

Creates a FLMetier object from a FLQuant object.

signature(catches=missing) :

Creates a FLMetier from scratch

Methods

catch(FLCore) :

Accessor method for the catch slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

catch.n(FLCore) :

Accessor method for the catch.n slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

catch.q(FLCore) :

Accessor method for the catch.q slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

catch.sel(FLCore) :

Accessor method for the catch.sel slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

catch.wt(FLCore) :

Accessor method for the catch.wt slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

discards(FLCore) :

Accessor method for the discards slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

discards.n(FLCore) :

Accessor method for the discards.n slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

discards.sel(FLCore) :

Accessor method for the discards.sel slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

discards.wt(FLCore) :

Accessor method for the discards.wt slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

FLFleet(FLCore) :

Describe method

signature(object=missing)

landings(FLCore) :

Accessor method for the landings slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

landings.n(FLCore) :

Accessor method for the landings.n slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

landings.sel(FLCore) :

Accessor method for the landings.sel slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

landings.wt(FLCore) :

Accessor method for the landings.wt slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

price(FLCore) :

Accessor method for the price slot for a given FLCatch or across the FLCatches objects

signature(object=missing)

FLFleet(FLCore) :

creates a FLFleet object from a FLMetier object. All other FLFleet slots are set to NA.

signature(object=missing)

Author(s)

The FLR Team

See Also

catch, catch.n, catch.q, catch.sel, catch.wt, discards, discards.n, discards.sel, discards.wt, FLFleet, landings, landings.n, landings.sel, landings.wt, price, FLComp

Examples

data(bt4)
mymetier<-metier(bt4, "TBB")
summary(mymetier)

catch(mymetier) #returns a FLQuants object
catch(mymetier, "ple") #returns a FLQuant object

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