FLFleet-class {FLCore}R Documentation

FLFleet class and methods

Description

FLFleet creates the FLFleet objects. These objects contain fleet data.

Objects from the Class

Objects can be created by calls of the form new("FLFleet", ...).

Slots

name:
the name of the fleet.
desc:
a description of the fleet.
range:
age and year ranges.
catches:
catches by species as a list of FLCatch objects.
effort:
An FLQuant holding the fishing effort
capacity:
An FLQuant holding the capacity of the fishing fleet
vcost:
variable costs.
fcost:
fixed costs.
crewshare:
crewshare.

Methods

Summarise contents:

summary
signature(obj = "FLFleet"): prints the dimensions for each slot in the object, including the dimensions of FLCatch objects and FLQuants in effort and capacity.

Plot contents:

plot
signature(x = "FLFleet", y = "missing"): Generates a number of standard plots for an FLFleet. Currently, only one plot style can be specified, by using the type parameter. If type="summary", a four-section plot is created showing the effort and capacity of the fleet, a sum of the three types of costs in the object and the total landings of each of the catches of the Fleet. This "summary" type is also the default.

Object coercion:

as.FLStock
signature(obj = "FLFleet"): Creates a new FLStock based upon the input FLFleet. If data for more than one stock are present inside the FLFleet object, one can be selected using name and gear. If name or gear is not specified, and data for only one stock is present, the new FLStock is filled with the corresponding data. When the fleet catches more than one stock, it is necessary to specify one of them. name and/or gear then identifies the stock inside the FLFleet object to be used by comparing to name and gear slot of each FLCatch. If more than one FlCatch matches name, the data in the slots is summed for numbers, catch, discards and landings. cach.wt, landings.wt and discards.wt are average, weighted by numbers in the individual catches.

Indexing and subsetting:

window:
To specify a temporal window, along the year dimension, over which to subset or extend the object.

Revenue calculation:

revenue
signature(obj = "FLFleet"): Calculates the revenue of the fleet. By default, the gross revenue is calculated by the sum of the products of price, landings.n and landings.wt of all FLCatches. By specifying type="nett", the nett revenue is calculated by subtracting the sum of crewshare, vcost and fcost from the gross revenue.

Other:

transform
signature(obj = "FLFleet"): Alters the content of individual slots in a FLFleet object. Only the data is altered, not dimnames.

Author(s)

FLR Team

References

See Also

FLCatch-class is.FLFleet, as.FLFleet,

Examples

   

# Create a new fleet
catch <- FLQuant(NA, dimnames=list(age=as.character(1:12), year=as.character(c(1991:2000)),
          unit="all", season="all", area="all"))
fleet <- FLQuant(NA, dimnames=list(quant="all", year=as.character(c(1991:2000)),
          unit="all", season="all", area="all"))
my.fleet <- FLFleet(iniFLQuantFleet=fleet, iniFLQuantCatch=catch, catchname="examplecatch",
desc="Just an examplefleet")
my.effort <- FLQuant(matrix(rpois(20,120), nrow=1))
my.range <- c(1, 8, 8, 1980, 2000)
my.fleet@effort <- my.effort
my.fleet@catches[[1]]@range <- my.range
summary(my.fleet)

[Package FLCore version 1.3-3 Index]