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

Set and document default for exponents in set...() functions #271

Open
gustavdelius opened this issue Nov 22, 2022 · 0 comments
Open

Set and document default for exponents in set...() functions #271

gustavdelius opened this issue Nov 22, 2022 · 0 comments
Labels
code improvement This issue relates to code quality rather than user-facing features documentation Issue relates to documentation low priority minor effort Resolving this issue will involve a minor effort setting parameters Issue relates to the part of mizer used for setting up MizerParams objects.

Comments

@gustavdelius
Copy link
Member

setSearchVolume() assumes that the search volume exponent q is given in the species_params data frame. This usually creates no problems because a value is set in the new....Params() functions. But that is not enough. validSpeciesParams() neither sets a default nor complains if q is missing. If one then calls setSearchVolume() with a supposedly valid species params data frame one gets a cryptic error. The straightforward solution is to let setSearchVolume() use a default value if q is missing. This default should be lambda - 2 + n

The exact same comment applies to setMaxIntakeRate() and the exponent n and also to setMetabolicRate() and the exponent p except that in the latter case surprisingly p can be supplied as an argument.

@gustavdelius gustavdelius added setting parameters Issue relates to the part of mizer used for setting up MizerParams objects. documentation Issue relates to documentation minor effort Resolving this issue will involve a minor effort code improvement This issue relates to code quality rather than user-facing features low priority labels Nov 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code improvement This issue relates to code quality rather than user-facing features documentation Issue relates to documentation low priority minor effort Resolving this issue will involve a minor effort setting parameters Issue relates to the part of mizer used for setting up MizerParams objects.
Projects
None yet
Development

No branches or pull requests

1 participant