Skip to content

Commit

Permalink
load update
Browse files Browse the repository at this point in the history
  • Loading branch information
tymjackson committed Oct 14, 2024
1 parent 5735fe9 commit 43e8698
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion R/get_total_catch.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
#' @param ft_data NULL. Fish ticket data with fields 'crab_year', 'fishery', 'effort' and whatever variables are specified in by.
#' @param stock NULL. Character string stock abbreviation: BSSC, WBT, EBT, BBRKC, EAG, WAG, PIGKC, SMBKC, PIBKC, PIRKC, WAIRKC.
#' @param by NULL. Vector of column names other than crab year, fishery, and group to use as a grouping variable.
#' @param lump T/F. Lump shell condition into new and old (TRUE) or not (FALSE). Default = TRUE.
#' @param units NULL. Unit of measurement, "t" or "lb". Default = "t".
#' @return Data frame including crab year, fishery, grouping variables, and average weight. Average weights used for expansion to weight are only based on crab year, fishery, and sex. No other 'by' variables are included here, so that the sum of total catch by variables (i.e., sex and shell condition) will equal the total catch by sex.
#' @examples get_avg_wt(pot_data, crab_data, ft_data, stock = "BBRKC")
#'
#' @export
#'
get_total_catch <- function(pot_data, crab_data, ft_data, stock, by = NULL, units = "t") {
get_total_catch <- function(pot_data, crab_data, ft_data, stock, by = NULL, lump = T, units = "t") {

if(!(units %in% c("t", "lb"))){stop("Do not recognize the units, use t or lb")}

Expand Down

0 comments on commit 43e8698

Please sign in to comment.