Skip to contents

Access or assign distribution for cryptic capture parameter \(\kappa\)

Source: R/cryptic_capture.R
cryptic_capture.Rd

This function can used to access or assign the distribution specifications for the longline cryptic capture multiplier (cryptic_capture) within the sefraData object.

Usage

cryptic_capture(object, ...)

# S4 method for class 'sefraData'
cryptic_capture(object)

cryptic_capture(object, ...) <- value

# S4 method for class 'sefraData,list'
cryptic_capture(object) <- value

Arguments

object

a sefraData class object

...

additional arguments to the generic function (not used)

value

a list or data frame with elements: distribution, par1 and par2. At present this is assumed to apply to all fishery and species groups. The distribution must be 'log-normal' (see distributions). The par1 and par2 are numeric values that paramaterise this distributions.

Examples

dat <- sefraData(c('DIW', 'DQS', 'TWD'))
#> species codes input: including all species-dependent capture codes
#> constructed 'sefraData' object
fishery_groups(dat) <- c('F1', 'F2', 'F3')
species_groups(dat) <- c('S1', 'S1', 'S2')
#> Warning: assumption that vector of group names is ordered by species in object
cryptic_capture(dat) <- list(distribution = c('log-normal'), 
   par1 = 0.1, par2 = 0.1)
#> 3 fishery groups
#> 2 species groups
cryptic_capture(dat)
#>    distribution fishery_group species_group  par value
#> 1    log-normal            F1            S1 par1   0.1
#> 2    log-normal            F2            S1 par1   0.1
#> 3    log-normal            F3            S1 par1   0.1
#> 4    log-normal            F1            S2 par1   0.1
#> 5    log-normal            F2            S2 par1   0.1
#> 6    log-normal            F3            S2 par1   0.1
#> 7    log-normal            F1            S1 par2   0.1
#> 8    log-normal            F2            S1 par2   0.1
#> 9    log-normal            F3            S1 par2   0.1
#> 10   log-normal            F1            S2 par2   0.1
#> 11   log-normal            F2            S2 par2   0.1
#> 12   log-normal            F3            S2 par2   0.1