Skip to contents

Example Performance Metric: Calculate total catch over a range of years

Source: R/example_perf_metrics.R
get_total_catch.Rd

Example performance metric that calculates total catch over a range of years in a Stock Synthesis data file. This function aggregates catch across fleets, so may not be appropriate for models with multiple fleets.

Usage

get_total_catch(datfile, yrs)

Arguments

datfile

Path to the Stock Synthesis data file containing catch

yrs

A vector containing a range of years. Years are as defined in the Stock Synthesis data file.

Value

The total catch, a number.

Examples

if (FALSE) {
total_catch <- get_total_catch(datfile = "ss3model/dat.ss", yrs = 25:100)
total_catch
}