calculate_data_units {ss3sim}

Given sampling arguments, calculate super set of fleets, years, and data types.

Description

Given sampling arguments, calculate super set of fleets, years, and data types.

Usage

calculate_data_units(index_params = NULL, lcomp_params = NULL,
  agecomp_params = NULL, calcomp_params = NULL,
  mlacomp_params = NULL, wtatage_params = NULL)

Arguments

index_params

Named lists containing the arguments for sample_index.

lcomp_params

Named lists containing the arguments for sample_lcomp.

agecomp_params

Named lists containing the arguments for sample_agecomp.

calcomp_params

Named lists containing the arguments for sample_calcomp.

mlacomp_params

Named lists containing the arguments for sample_mlacomp.

wtatage_params

Named lists containing the arguments for sample_wtatage.

Value

An invisible list of fleets, years, and types.

Note

A superset by nature is larger than the individual sets used to create it (unless all sampling arguments are identical), so that the returned list will created some unnecessary combinations. This was done intentionally for simplicity but may be changed later. See the vignette for further information.

See further examples in change_data.

Author(s)

Cole Monnahan

See Also

clean_data, change_data

Examples

## Only one fleet
calculate_data_units(lcomp_params = list(fleets = 1, years = c(3, 4, 6)))
## Add new fleet
calculate_data_units(lcomp_params = list(fleets = 1, years = c(3, 4, 6)),
                     agecomp_params = list(fleets = 2, years = 5))