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

improve description of hermaphroditism #258

Merged
merged 6 commits into from
Oct 29, 2024
Merged

Conversation

iantaylor-NOAA
Copy link
Contributor

@iantaylor-NOAA iantaylor-NOAA commented Oct 25, 2024

Here's a draft pull request inspired by this recent conversation https://groups.google.com/g/ss3-forum/c/S-Krkkn9qao.

If an equation is necessary, we can likely do something similar to the description of the parameter trends which also use cumulative normal functions:
https://github.com/nmfs-ost/ss3-doc/blob/main/tv_parameter_description.tex#L81.

See issue #259

@iantaylor-NOAA iantaylor-NOAA added documentation Improvements or additions to documentation Manual labels Oct 25, 2024
Copy link

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

Copy link

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

Copy link

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

@e-perl-NOAA
Copy link
Collaborator

@iantaylor-NOAA please see my comment in the issue and my additional commits. I'm going to convert this from a draft to ready for review.

@e-perl-NOAA e-perl-NOAA marked this pull request as ready for review October 28, 2024 15:37
Copy link

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

Copy link

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

Copy link

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

Copy link

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

Copy link

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

@iantaylor-NOAA
Copy link
Contributor Author

@e-perl-NOAA, thanks for your work on this.
Can you take one more look at this and if it looks good then squash and merge?
Additional changes include

This resolves issue #259.

Copy link

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

@marcnadon
Copy link

Thank you all, this is much clearer now. Appreciate the super quick response to this issue!

9control.tex Outdated
@@ -677,28 +677,28 @@
& & 0 = not used; \\
& & 1 = invoke female to male age-specific function; and \\
& & -1 = invoke male to female age-specific function. \\
& & Note: this creates the annual, age-specific fraction that change sex, it is not the fraction that is each sex. \Bstrut\\
& & Note: this creates the annual, age-specific fraction that change sex, it is not the fraction that is each sex. Also, the fraction female parameter should be configured to reflect the fraction of age 0 fish. Values of 0 or 1 may lead to NaN likelihoods, so we recommend changing values that would be fixed at 0 or 1 to 0.000001 or 0.999999.\Bstrut\\
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iantaylor-NOAA Is this the right place to put this? It looks like this section should be fixed at 0, 1, or -1 to turn on the option and the note makes it a bit confusing.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this function that is being turned on related to he Fraction Female section?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@e-perl-NOAA You're right. I wanted that information as close to the top of the hermaphroditism section as possible, but it would just get lost in that note. Instead, I've created a new intro section in 21ef32a prior to the table of control file settings which hopefully provides better overall information on the options and moved all the notes into that paragraph.

Copy link

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

Copy link

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

9control.tex Outdated
@@ -677,28 +677,28 @@
& & 0 = not used; \\
& & 1 = invoke female to male age-specific function; and \\
& & -1 = invoke male to female age-specific function. \\
& & Note: this creates the annual, age-specific fraction that change sex, it is not the fraction that is each sex. \Bstrut\\
& & Note: this creates the annual, age-specific fraction that change sex, it is not the fraction that is each sex. Also, the fraction female parameter should be configured to reflect the fraction of age 0 fish. Values of 0 or 1 may lead to NaN likelihoods, so we recommend changing values that would be fixed at 0 or 1 to 0.000001 or 0.999999.\Bstrut\\
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this function that is being turned on related to he Fraction Female section?

@e-perl-NOAA
Copy link
Collaborator

@iantaylor-NOAA Thanks so much for your work on this!

@e-perl-NOAA e-perl-NOAA merged commit 12630ad into main Oct 29, 2024
4 checks passed
Copy link

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

Copy link

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 deleted the hermaphroditism_description branch October 29, 2024 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Manual
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants