make_gadget_fleet: Create a list of class "gadget_fleet" that can be used to...

In inspktrgadget/gadgetSim: Create Gadget replicates for use in simulation studies

Description

This function takes named lists as arguments with elements that correspond to the different parameters of a Gadget fleet component (see Gadget User Guide). Names of objects passed to ... will be used as the fleet names. The first element of the named list should by type, which specifies the type that fleet will be (i.e. type = totalfleet, type = numberfleet, etc.)

Usage

make_gadget_fleet(...)

Arguments

...	Named objects corresponding to the appropriate arguments to various Gadget fleet types

Details

WARNING: The implementation of this function for fleets of type quotafleet has not been adequately tested. It should be expected that this portion of the function behaves unexpectedly. If you encounter this and wish it to get fixed sooner rather than later, post an issue to https://github.com/inspktrgadget/gadgetSim

Value

A list of class gadget_fleet (or a list of class gadget_fleets if composed of multiple fleets)

Examples

base_data <-
  expand.grid(year = 1:10, steps = 1:4, area = 1, fleetname = "btm")
base_data$amount <- sample(1e5:1e6, nrow(base_data), replace = TRUE)
btm_fleet <-
  list(type = "totalfleet",
       suitability = make_exponential_suit("btm", "cod"),
       amount = base_data)
make_gadget_fleet(btm = btm_fleet)

# different fleet type
lin_flt_data <-
  expand.grid(year = 1:10, steps = 1:4, area = 1, fleetname = "lin")
lin_flt_data$scaling <- c(seq(0.01,0.8, length.out = 20),
                          seq(0.8,0.2,length.out = 20))
lin_flt <-
  list(type = "linearfleet",
       suitability = make_exponential_suit("lin", "cod"),
       amount = lin_flt_data)
make_gadget_fleet(lin = lin_flt)

# can handle multiple fleet types
make_gadget_fleet(btm = btm_fleet, lin = lin_flt)

inspktrgadget/gadgetSim documentation built on May 10, 2019, 9:51 a.m.