Skip to contents

Set up default selectivity parameters

Source: R/setup_default_parameters.R
setup_default_Selectivity.Rd

This function sets up default parameters for a selectivity module.

Usage

setup_default_Selectivity(
  data,
  fleet,
  module_type = c("Logistic", "DoubleLogistic")
)

Arguments

data

A FIMSFrame object returned from running FIMSFrame() on your long input data.

fleet

A string specifying the name of the fleet for which selectivity parameters are being created.

module_type

A string specifying the desired form of selectivity. Allowable forms include Logistic, DoubleLogistic and the default is Logistic. See setup_default_parameters for full column descriptions.

Value

A tibble containing the default selectivity parameters. See setup_default_parameters for full column descriptions.

Details

The function builds module-specific defaults by calling helper functions for data, fleet, selectivity, recruitment, maturity, growth, and population components, then combines those defaults into one tibble. You can modify the returned tibble before fitting a model (for example, updating maturity and selectivity parameter values).

To create the default initial numbers at age, this function uses the defaults from setup_default_Population() and setup_default_Recruitment(), which are passed to setup_default_init_naa() to calculate initial numbers at age.

See also

Examples

if (FALSE) { # \dontrun{
default_selectivity_parameters <- FIMS:::setup_default_Selectivity(
  data = FIMSFrame(data_big),
  fleet = "fleet1",
  module_type = "Logistic"
)
} # }