Skip to content

Commit

Permalink
fix: documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chantelwetzel-noaa committed Nov 7, 2024
1 parent d83dc05 commit 417db85
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
6 changes: 2 additions & 4 deletions R/plot_weight_length.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,10 @@
#' the plot. The default is `NULL` and will not add parameters to the plot.
#' @param col_length A numeric or character value specifying the column
#' to use in `data` for length information. These lengths are assumed to
#' be in centimeters. The default value is `lengthcm`, which is added
#' to a data set automatically when running [cleanPacFIN()].
#' be in centimeters. The default value is `length_cm`.
#' @param col_weight A numeric or character value specifying the column
#' to use in `data` for weight information. These weights are assumed to
#' be in kilograms The default value is `weightkg`, which is added
#' to a data set automatically when running [cleanPacFIN()].
#' be in kilograms The default value is `weight_kg`.
#' Using kilograms is the default because Stock Synthesis assumes the
#' weight-length parameters are calculated using centimeters and kilograms.
#' The reported values are easily scaled to give you results in grams if
Expand Down
6 changes: 2 additions & 4 deletions man/plot_weight_length.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 417db85

Please sign in to comment.