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

compute_presence #340

Open
voytek opened this issue Jan 23, 2025 · 1 comment
Open

compute_presence #340

voytek opened this issue Jan 23, 2025 · 1 comment

Comments

@voytek
Copy link
Contributor

voytek commented Jan 23, 2025

The compute_presence function allows users to pass whether they want the output as a ration or percent, but the SpectralTimeModel report from strings.py always prints the %, regardless of the output flag.

So we either need to change the report, or just pick one presence reporting style and stick with it.

I'm inclined to vote for the latter, since "80%" is less ambiguous than (0.80), people can divide by 100 if they really want, and fewer options to track is better if they're not critical for the method or understanding.

@TomDonoghue
Copy link
Member

TomDonoghue commented Feb 4, 2025

Oops, good catch - the compute_presence has output settings, but the reports were inconsistent in defining which output they used, even though they were set up to take percents. The easy fix for the literal error is to male the SpectralTimeModel report set the presence output just like the Event model does - which is done in #341

I also agree on picking on presence reporting standard - though the string outputs are now consistent between model types, there's an inconsistency between the string report using % and the plot using ratio (see fe.report output here), which is no good in terms of consistency.

If we prefer the % then the quick fix is to update the event presence plot to use percent - does that sound good? We could also optionally also simplify the output types of compute_presence, but as a 'behind the scenes' function, I don't think it matters much if it defines 1 or 2 output types.

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

No branches or pull requests

2 participants