Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise section on Richards growth function #269

Merged
merged 1 commit into from
Dec 5, 2024

Conversation

arni-magnusson
Copy link
Contributor

@arni-magnusson arni-magnusson commented Dec 5, 2024

In light of the findings of Arni and Ian analyzing the Richards growth function in Stock Synthesis (draft vignette) and a related question by Larry Jacobson on the Gompertz growth function (forum message), I would like to propose a revised text for the Richards growth function in the User Manual.

This pull request makes the following changes:

  • Refer to "Richards" rather than "Schnute/Richards" growth function, to simplify and acknowledge that the Schnute parametrization (1981, Eq. 15) produces the same curves as other Richards parametrizations. Also to prevent confusion with the five-parameter Schnute-Richards (1990) growth function, which is quite different.

  • Replace the rather old and vague text that "when this function was first introduced, it was required that the A0 parameter be set to 0.0" with similar guidance that "when A1 is greater than the youngest age in the model, some combinations of Richards growth parameters can lead to undefined (NaN) predicted length for the younger ages".

  • No longer refer to b<0 as the "Richards" model and b>0 as the "generalized von Bertalanffy" model. In modern parlance, all values of b are the Richards model. The models referred to as Richards growth models by Tjorve and Tjorve (2010) and the FSA package produce the same curves as the Schnute (1981, Eq. 15) function that is used in Stock Synthesis.

  • Guide the user that b should not be set to precisely 0 and that to use the Gompertz growth function, the user can fix the Richards shape parameter at a small value such as b=0.0001. The main Richards equation still applies and there is no real need for showing the equivalent Schnute (1981, Eq. 16) case 2 (Gompertz) function that is not implemented in Stock Synthesis.

  • Omit the somewhat unclear guidance that it might be necessary to constrain b to "different ranges". In practice, b will probably be somewhere between -3 and +6, as shown by the corresponding growth curves in the vignette.

  • Last, but not least, mention that the SS3 website includes a vignette providing further technical insights for using the Richards growth model in Stock Synthesis.

Copy link

github-actions bot commented Dec 5, 2024

Here are the artifacts from your PR:
SS330_User_Manual.html
Please review your changes in the linked artifacts.

Copy link

github-actions bot commented Dec 5, 2024

Here are the artifacts from your PR:
SS330_User_Manual.pdf
textidote_report
Please review your changes in the linked artifacts.

@e-perl-NOAA e-perl-NOAA merged commit af78ab9 into nmfs-ost:main Dec 5, 2024
2 checks passed
Copy link

github-actions bot commented Dec 5, 2024

Here are the artifacts from your PR:
SS330_User_Manual.html
Please review your changes in the linked artifacts.

Copy link

github-actions bot commented Dec 5, 2024

Here are the artifacts from your PR:
SS330_User_Manual.pdf
textidote_report
Please review your changes in the linked artifacts.

@Rick-Methot-NOAA
Copy link
Collaborator

Thanks much Arni for this excellent contribution.
Rick

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants