FLMetierExt: FLMetierExt class and the methods to construct it.

FLMetierExtR Documentation

FLMetierExt class and the methods to construct it.

Description

It extends the FLMetier class defined in FLFleet package. The only difference is that that the catches slot is a FLCatchesExt object.

Usage

## S4 method for signature 'FLCatchExt'
FLMetierExt(catches, gear = "NA", ...)

## S4 method for signature 'FLCatchesExt'
FLMetierExt(catches, gear = "NA", ...)

## S4 method for signature 'FLQuant'
FLMetierExt(catches, gear = "NA", ...)

## S4 method for signature 'missing'
FLMetierExt(catches, gear = "NA", ...)

## S4 method for signature 'FLMetierExt,ANY,missing,ANY'
x[i, drop = FALSE]

## S4 method for signature 'FLMetierExt,ANY,missing'
x[[i, drop = FALSE]]

Arguments

catches, x

An object of class FLQuant, missing or FLCatchExt.

gear

A character vector with the name of the gear used in the metier.

...

Other objects to be assigned by name to the class slots

i

subindices.

drop

If TRUE, deletes the dimensions of an array which have only one level.

Details

The FLMetierExt object contains a representation of the metier of a fishing fleet as constructed for the purposes of fleet dynamic modelling. This includes information on effortshare and variable costs.

Value

The constructors return an object of class FLMetierExt.

Slots

gear

A character with the gear name of a fleet's metier.

effshare

An FLQuant with the effort share of a fleet's metier relative to fleet's total effort (the sum of all metiers effshares for a fleet must sum 1).

vcost

An FLQuant with the varible costs of a fleet's metier. These costs should be given by vessel and based on the effort units used for the fleet's effort (within the FLFleetExt object). The number of vessels by fleet must be included in the covars object.

catches

A FLCatchesExt with information on the fleet's metier catches.

name

The name of the stock.

desc

A description of the object.

range

The range as in other FLR objects: c("min","max","plusgroup","minyear","maxyear").


flr/FLBEIA documentation built on Feb. 22, 2024, 1:36 a.m.