136 multiple groups in psdadd

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: FSA
 Version: 0.10.9000
-Date: 2025-8-16
+Date: 2026-1-7
 Title: Simple Fisheries Stock Assessment Methods
 Description: A variety of simple fish stock assessment methods.
 Authors@R: c(

NEWS.md

@@ -1,8 +1,14 @@
 # FSA 0.10.9000
+* Updated the PSD and Relative Weight computation articles to reflect the changes to `psdVal()`, `psdAdd()`, `wsVal()`, and `wrAdd()`.
 * `chapmanRobson()`: Added catch for when n+T<1 and n+T<2. This addresses [#131](https://github.com/fishR-Core-Team/FSA/issues/131)).
 * `metaM()`: Added `method="HamelCope"` to address [#133](https://github.com/fishR-Core-Team/FSA/issues/133). A few minor edits to documentation.
-* `PSDlit`: Added info for Flier and Longear Sunfish.
-* `wSlit`: Added info for Flier and Longear Sunfish. This addresses [#122](https://github.com/fishR-Core-Team/FSA/issues/122)).
+* `psdAdd()`: Addressed bugs as described in [#136](https://github.com/fishR-Core-Team/FSA/issues/136)) and [#137](https://github.com/fishR-Core-Team/FSA/issues/137). Added `thesaurus` functionality. Reworked examples in documentation. Reworked testing framework. Thanks to Dave Glover.
+* `PSDlit`: Added info for Flier and Longear Sunfish to address [#122](https://github.com/fishR-Core-Team/FSA/issues/122)) and Northern Pikeminnow. Also updated information for Alabama Bass and Spotted Bass. Duplicated lines that combine `species` and `group` to partially address [#137](https://github.com/fishR-Core-Team/FSA/issues/137).
+* `psdVal()`: Added `dat=` to allow more flexibility when called from `psdAdd()`.
+* `PSDWRTest`: Added for testing PSD and relative weight functions.
+* `wrAdd()`: Addressed bugs similar to those for `psdAdd()`. Added `thesaurus` functionality. Reworked examples in documentation. Reworked testing framework (especially expanded validation of results with hand-calculations).
+* `wSlit`: Added info for Flier and Longear Sunfish to address [#122](https://github.com/fishR-Core-Team/FSA/issues/122)). Also updated information for Alabama Bass (further removed Spotted Bass (Alabama subspecies)), Spotted Bass, and Northern Pikeminnow (further removed Northern Squawfish (synonym of Northern Pikeminnow that is no longer used)). Duplicated lines that combine `species` and `group` to partially address [#137](https://github.com/fishR-Core-Team/FSA/issues/137).
+* `wsVal()`: Added `dat=` to allow more flexibility when called from `wrAdd()`.
 
 # FSA 0.10.0
 * Updated `test-coverage.yaml` and moved a `# nocov start` and `# nocov end` in `bootstrap.r` to address the errors with `test-coverage.yaml`. Addresses [#118](https://github.com/fishR-Core-Team/FSA/issues/118).

R/PSDWRtest.R

@@ -0,0 +1,44 @@
+#' @title Hypothetical weight-length data for testing PSD and relative weight functions
+#'
+#' @description Hypothetical weight-length and associated data. These data are useful for testing PSD and relative weight functions (e.g., \code{\link{psdAdd}} and \code{\link{wrAdd}}).
+#'
+#' @name PSDWRtest
+#'
+#' @docType data
+#'
+#' @format A data frame of many observations on the following 5 variables:
+#'  \describe{
+#'    \item{species}{Species name}
+#'    \item{location}{Broad location of capture}
+#'    \item{len}{Length in mm}
+#'    \item{wt}{Weight in g}
+#'    \item{sex}{Sex as \code{F} for female, \code{M} for male, or \code{U} or \code{NA} for unknown or unrecorded}
+#'  }
+#'
+#' @section Topic(s):
+#'  \itemize{
+#'    \item Size structure
+#'    \item Proportional size structure
+#'    \item Relative stock density
+#'    \item Proportional stock density
+#'    \item Relative weight
+#'    \item Standard weight
+#'    \item Condition
+#'  }
+#'
+#' @concept Size Structure
+#' @concept PSD
+#' @concept Condition
+#' @concept Relative Weight
+#' @concept Standard Weight
+#'
+#' @seealso \code{\link{psdAdd}}, \code{\link{psdCalc}}, and \code{\link{wrAdd}}
+#'
+#' @keywords datasets
+#'
+#' @examples
+#' str(PSDWRtest)
+#' peek(PSDWRtest,n=20)
+#' unique(PSDWRtest$species)
+#'
+NULL

R/PSDlit.R

@@ -1,6 +1,9 @@
 #' @title Gabelhouse five-cell length categories for various species.
 #'
 #' @description Cutoffs for the Gabelhouse five-cell length categories for a variety of species.
+#' 
+#' @details Entries for some species (e.g., \dQuote{Muskellunge} and \dQuote{Walleye}) have been duplicated for sub-groups to facilitate use with relative weight calculations. For example, entries for \dQuote{Muskellunge (overall)}, \dQuote{Muskellunge (female)}, and \dQuote{Muskellunge (male)} are duplicates of the entry for \dQuote{Muskellunge}; i.e., these entries in \code{PSDlit} are not necessarily just for those sub-groups but this allows for seamless similar computations of relative weights for these sub-groups.
+#' 
 #'
 #' @name PSDlit
 #'

R/WSlit.R

@@ -3,6 +3,8 @@
 #' @description Parameters for all known standard weight equations.
 #'
 #' @details The minimum TL for the English units were derived by rounding the converted minimum TL for the metric units to what seemed like common units (inches, half inches, or quarter inches).
+#' 
+#' Entries for \dQuote{Chinook Salmon (landlocked)} and \dQuote{Striped Bass (landlocked)} are the same as for \dQuote{Chinook Salmon} and \dQuote{Striped Bass} but were added to facilitate use with PSD calculations as Gabelhouse lengths are only published for the landlocked sub-group; i.e., these entries in \code{WSlit} are not necessarily just for landlocked populations.
 #'
 #' @name WSlit
 #'