Improve reference index and clarify w_max terminology in docs#449
Open
gustavdelius wants to merge 1 commit into
Open
Improve reference index and clarify w_max terminology in docs#449gustavdelius wants to merge 1 commit into
gustavdelius wants to merge 1 commit into
Conversation
Documentation-only changes to make the website more useful and to make the maximum-size terminology consistent. Reference index (pkgdown/_pkgdown.yml): - Add an "Overview: the mizer workflow" section at the top framing the page as a five-stage pipeline (create -> calibrate -> tune dynamics -> project -> analyse) with links to the key function in each stage. - Disambiguate related function families: calibrate...()/match...() and ...Biomass/...Number, and the plot...() variants (...2, ...Relative, ...ObservedVsModel). - Map mizer's mortality-rate names onto standard fisheries notation (M2, F, Z), noting getResourceMort() is resource mortality, not fish M. w_max message wording (R/setReproduction.R, R/manipulate_species.R): - Error messages that called w_max a species' "maximum size" now describe it as the upper size-grid boundary, consistent with w_max being purely computational (biological max size is w_inf, reproduction cut-off is w_repro_max). Tests updated to match. Model-setup wrappers (R/newSingleSpeciesParams.R, R/wrapper_functions.R): - Document why newSingleSpeciesParams(), newTraitParams() and newCommunityParams() set w_max = w_repro_max: without diffusion no individual grows beyond w_repro_max, so no grid headroom is needed. To be revisited when the constructors gain a diffusion parameter (#339). No behaviour changes. docs/ site regeneration is intentionally excluded; rebuild on merge as usual. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only improvements to make the website more useful for fisheries-science researchers and to make the maximum-size terminology consistent across the package. No behaviour changes.
Reference index (
pkgdown/_pkgdown.yml)mizer-packagetopic, which moved out of "Classes".)calibrate...()vsmatch...(),...Biomassvs...Number, and theplot...()variants (...2= overlay two objects,...Relative= ratio,...ObservedVsModel).getPredMort()↔ M2,getExtMort()↔ residual M,getFMort()↔ F,getMort()↔ Z, with an explicit warning thatgetResourceMort()is mortality on the resource, not a component of fish M.w_maxmessage wording (R/setReproduction.R,R/manipulate_species.R)Error messages that referred to
w_maxas a species' "maximum size" now describe it as the upper size-grid boundary, consistent withw_maxbeing a purely computational parameter (the biological maximum size isw_inf; the reproduction cut-off isw_repro_max). The three affected test assertions were updated to match.Model-setup wrappers (
R/newSingleSpeciesParams.R,R/wrapper_functions.R)newSingleSpeciesParams(),newTraitParams()andnewCommunityParams()now document why they setw_max = w_repro_max: because they do not yet set up stochastic growth by diffusion, no individual grows beyondw_repro_max, so no grid headroom above it is needed. This is deferred, not changed — to be revisited when the constructors gain a diffusion parameter (#339). Man pages regenerated.Notes
_pkgdown.yml, and the matching test assertions.test-setReproduction.R,test-manipulate_species.R) pass, and all three constructors build with the documentedw_max == w_repro_maxinvariant holding.docs/site is intentionally excluded from this PR (following the repo convention of source-only commits); rebuild the site on merge as usual.🤖 Generated with Claude Code