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

clarify missingness of point estimates; add examples for determining output_type_id format #197

Merged
merged 21 commits into from
Oct 31, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: Becky Sweger <[email protected]>
  • Loading branch information
zkamvar and bsweger authored Oct 30, 2024
commit 3556918b88e82ad18e966b450dd7460deec3dd84
4 changes: 3 additions & 1 deletion docs/source/user-guide/model-output.md
Original file line number Diff line number Diff line change
@@ -46,7 +46,9 @@ one-week-ahead incidence, but probabilities for the timing of a season peak:
| EW202242 | weekly rate | 1 | sample | 2 | 3 |
:::

[^batman]: `NA` (without quotes) indicates missingness in R, which is the expected `output_type_id` for a `mean` `output_type`.
[^batman]: The `output_type_id` for point estimates (e.g. `mean`) is not applicable. To
reflect this, we need to signal that this is a missing value. In R, missing values are
encoded as `NA`, and in Python, they are encoded as `None`.
This is discussed in the [output type table](#output-type-table)