FLFisherycpp: An internal class for homogeneous fishing fleets

In iagomosqueira/FLFishery: Classes and Methods for Simpler Fleet/Fishery Modelling

An internal class for homogeneous fishing fleets

Description

The same as the FLFishery class but all predictModel slots have been turned into FLQuant objects. The class is used for passing to C++ FLR objects.

Usage

## S4 method for signature 'FLFisherycpp'
capacity(object)

## S4 replacement method for signature 'FLFisherycpp,FLQuant'
capacity(object) <- value

## S4 replacement method for signature 'FLFisherycpp,numeric'
capacity(object) <- value

## S4 method for signature 'FLFisherycpp'
hperiod(object)

## S4 replacement method for signature 'FLFisherycpp,FLQuant'
hperiod(object) <- value

## S4 replacement method for signature 'FLFisherycpp,numeric'
hperiod(object) <- value

## S4 method for signature 'FLFisherycpp'
orevenue(object)

## S4 replacement method for signature 'FLFisherycpp,FLQuant'
orevenue(object) <- value

## S4 replacement method for signature 'FLFisherycpp,numeric'
orevenue(object) <- value

## S4 method for signature 'FLFisherycpp,ANY'
effort(object)

## S4 replacement method for signature 'FLFisherycpp,FLQuant'
effort(object) <- value

## S4 replacement method for signature 'FLFisherycpp,numeric'
effort(object) <- value

## S4 method for signature 'FLFisherycpp'
vcost(object)

## S4 replacement method for signature 'FLFisherycpp,FLQuant'
vcost(object) <- value

## S4 replacement method for signature 'FLFisherycpp,numeric'
vcost(object) <- value

## S4 method for signature 'FLFisherycpp'
fcost(object)

## S4 replacement method for signature 'FLFisherycpp,FLQuant'
fcost(object) <- value

## S4 replacement method for signature 'FLFisherycpp,numeric'
fcost(object) <- value

## S4 method for signature 'FLFisherycpp'
crewshare(object)

## S4 replacement method for signature 'FLFisherycpp,FLQuant'
crewshare(object) <- value

## S4 replacement method for signature 'FLFisherycpp,numeric'
crewshare(object) <- value

Arguments

object	Object to extract or operate on
value	Replacement value

Details

What have you done what's in your mind what do you need Where shall we go to let it out What have you seen, we don't know where you've been Life so often blows your candle out Believe in what is right, what's right for you tonight Who knows what the fuck it's all about

Slots

FLFisherycpp objects inherit from FLCatches woth a number of slots added.

.Data

The list of FLCatch object with catch data per stock, (FLCatches).

name

Name of the object, e.g. species or stock code, (character).

desc

Description of the data contents and origin, (character).

range

Ranges of age and years, plusgroup, (numeric).

capacity

Number of boats in the fleet, (FLQuant).

effort

Mean effort per boat applied by the fleet, (FLQuant).

hperiod

Start and end of fishing within each time step, as proportions. An FLQuant object with dimnames ‘quant=c(’start', 'end')' in the first dimension.

vcost

Variable costs per unit of effort, (FLQuant).

fcost

Variable costs per unit of effort, (FLQuant).

orevenue

Revenues obtained from sources other than landings, (FLQuant).

crewshare

Formula, parameter values and inputs to calculate the crew costs, (FLQuant).

Validity

You can inspect the class validity function by using getValidity(getClassDef('FLFishery'))

Accessors

All slots in the class have accessor and replacement methods defined that allow retrieving and substituting individual slots.

The values passed for replacement need to be of the class of that slot. A numeric vector can also be used when replacing FLQuant slots, and the vector will be used to substitute the values in the slot, but not its other attributes.

Constructor

A construction method exists for this class that can take named arguments for any of its slots. All slots are then created to match the requirements of the class validity. If an unnamed FLQuant object is provided, this is used for sizing but not stored in any slot.

Methods

Methods exist for various calculations based on values stored in the class:

ccost

Calculate the total crew costs by evaluating the formula in crewshare.

cost

Total costs, calculated.

lrevenue

.

revenue

.

profit

.

landings

.

discards

.

catch

.

catch.n

.

catch.wt

.

harvest

.

Author(s)

Iago Mosqueira, EC JRC.

See Also

FLCatches

Examples

data(ple4)
FLFishery(PLE=as(ple4, 'FLCatch'))

iagomosqueira/FLFishery documentation built on Nov. 10, 2023, 6:37 p.m.