From 70ce401a66d5c91d41e38ec413e433e24d6dda9b Mon Sep 17 00:00:00 2001 From: Elizabeth Perl Date: Tue, 30 Jan 2024 17:43:16 +0000 Subject: [PATCH] Add guidance on implications of "addtocomp" values (#215) --- 8data.tex | 6 ++++-- SS330_User_Manual.tex | 2 +- docs/SS330_User_Manual_release.html | 10 +++++++--- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/8data.tex b/8data.tex index ee3807e0..34052624 100644 --- a/8data.tex +++ b/8data.tex @@ -627,7 +627,7 @@ \subsection{Population Length Bins} \item A value read near the end of the starter.ss file defines the degree of tail compression used for the age-length key, called ALK tolerance. If this is set to 0.0, then no compression is used and all cells of the age-length key are processed, even though they may contain trivial (e.g., 1 e-13) fraction of the fish at a given age. With tail compression of, say 0.0001, the model, at the beginning of each phase, will calculate the min and max length bin to process for each age of each morphs ALK and compress accordingly. Depending on how many extra bins are outside this range, you may see speed increases near 10-20\%. Large values of ALK tolerance, say 0.1, will create a sharp end to each distribution and likely will impede convergence. It is recommended to start with a value of 0 and if model speed is an issue, explore values greater than 0 and evaluate the trade-off between model estimates and run time. The user is encouraged to explore this feature. \end{itemize} - +\hypertarget{length-comp-structure}{} \subsection{Length Composition Data Structure} \begin{tabular}{p{2cm} p{13cm}} \multicolumn{2}{l}{Enter a code to indicate whether or not length composition data will be used:} \Tstrut\Bstrut\\ @@ -680,6 +680,8 @@ \subsection{Length Composition Data Structure} \myparagraph{Added Constant to Proportions} Constant added to observed and expected proportions at length and age to make logL calculations more robust. Tail compression occurs before adding this constant. Proportions are renormalized to sum to 1.0 after constant is added. +The constant should be greater than 0. Commonly used values range from 0.00001 to 0.01. Larger values will cause differences among bins with smaller values to be less influential, leading to greater relative influence of the bins with largest proportions of the compositions. + \myparagraph{Combine Males \& Females} Combine males into females at or below this bin number. This is useful if the sex determination of very small fish is doubtful so allows the small fish to be treated as combined sex. If Combine Males \& Females > 0, then add males into females for bins 1 through this number, zero out the males, set male data to start at the first bin above this bin. Note that Combine Males \& Females > 0 is entered as a bin index, not as the size associated with that bin. Comparable option is available for age composition data. @@ -866,7 +868,7 @@ \subsubsection{Ageing Error} Code for ageing error calculation can be found in \href{https://github.com/nmfs-ost/ss3-source-code/blob/main/SS_miscfxn.tpl}{SS\_miscfxn.tpl}, search for function ``get\_age\_age'' or ``SS\_Label\_Function 45''. \subsubsection{Age Composition Specification} -If age data are included in the model, the following set-up is required, similar to the length data section. +If age data are included in the model, the following set-up is required, similar to the length data section. See \hyperlink{length-comp-structure}{Length Composition Data Structure} for details on each of these inputs. \begin{tabular}{p{2cm} p{2cm} p{2cm} p{1.5cm} p{1.5cm} p{2cm} p{2cm}} \multicolumn{7}{l}{Specify bin compression and error structure for age composition data for each fleet:} \\ diff --git a/SS330_User_Manual.tex b/SS330_User_Manual.tex index 121bec10..3f27d45e 100644 --- a/SS330_User_Manual.tex +++ b/SS330_User_Manual.tex @@ -147,7 +147,7 @@ \xpretocmd{\maketitle}{\TitlePageFont}{}{} \title{\textcolor[cmyk]{1.00,0.83,0.41,0.36}{Stock Synthesis User Manual\\ Version 3.30.22.1}} \author{Richard D. Methot Jr., Chantel R. Wetzel, Ian G. Taylor, Kathryn L. Doering,\\Elizabeth F. Perl, and Kelli F. Johnson\\\\\\NOAA Fisheries\\Seattle, WA} -\date{January 29, 2024} +\date{January 30, 2024} \begin{document} % ====== Title Page =================================================== diff --git a/docs/SS330_User_Manual_release.html b/docs/SS330_User_Manual_release.html index 5291021f..c8385dc6 100644 --- a/docs/SS330_User_Manual_release.html +++ b/docs/SS330_User_Manual_release.html @@ -11,7 +11,7 @@ - + Stock Synthesis User Manual Version 3.30.22.1 @@ -30,7 +30,7 @@

Stock Synthesis User
NOAA Fisheries
Seattle, WA

-

January 29, 2024

+

January 30, 2024