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

Renaming variables throughout for clarity #179

Merged
merged 10 commits into from
Jun 12, 2024
Merged

Conversation

damonbayer
Copy link
Collaborator

@damonbayer damonbayer commented Jun 12, 2024

Closes #156.

No changes to any of the model workings. Just renaming variables to make things easier to follow.

For example:

  • objects named x_dist that are actually random variables are renamed x_rv
  • object with vague names like latent are renamed to be more specific like latent_infections or latent_hosp_admissions
  • predicted as a descriptor is replaced by observed or sampled where appropriate
  • acronyms like ihr are replaced by more descriptive terms like infection_hosp_rate
  • i0 is consistently formatted as I0

@damonbayer damonbayer changed the title Renaming variable in hospital model for clarity Renaming variables in hospital model for clarity Jun 12, 2024
Copy link

codecov bot commented Jun 12, 2024

Codecov Report

Attention: Patch coverage is 97.10145% with 2 lines in your changes missing coverage. Please review.

Project coverage is 94.75%. Comparing base (df0b4d5) to head (53d778c).

Files Patch % Lines
model/src/pyrenew/latent/hospitaladmissions.py 95.23% 1 Missing ⚠️
model/src/pyrenew/model/admissionsmodel.py 95.23% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #179      +/-   ##
==========================================
- Coverage   94.77%   94.75%   -0.02%     
==========================================
  Files          39       39              
  Lines         842      839       -3     
==========================================
- Hits          798      795       -3     
  Misses         44       44              
Flag Coverage Δ
unittests 94.75% <97.10%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@damonbayer damonbayer changed the title Renaming variables in hospital model for clarity Renaming variables throughout for clarity Jun 12, 2024
@damonbayer damonbayer linked an issue Jun 12, 2024 that may be closed by this pull request
gvegayon
gvegayon previously approved these changes Jun 12, 2024
Copy link
Member

@gvegayon gvegayon left a comment

Choose a reason for hiding this comment

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

Minor comment

model/pyproject.toml Outdated Show resolved Hide resolved
Copy link
Collaborator

@AFg6K7h4fhy2 AFg6K7h4fhy2 left a comment

Choose a reason for hiding this comment

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

Looking good for the most part (see comments for flags and or suggestions).

Copy link
Collaborator

@AFg6K7h4fhy2 AFg6K7h4fhy2 left a comment

Choose a reason for hiding this comment

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

Another small remark regarding outdated use of typing.

@damonbayer damonbayer requested a review from AFg6K7h4fhy2 June 12, 2024 16:40
@damonbayer damonbayer requested a review from gvegayon June 12, 2024 16:40
Copy link
Collaborator

@AFg6K7h4fhy2 AFg6K7h4fhy2 left a comment

Choose a reason for hiding this comment

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

Everything looks good. See comment history.

@damonbayer damonbayer merged commit 428bcc4 into main Jun 12, 2024
7 of 8 checks passed
@damonbayer damonbayer deleted the dmb_rename_variables branch June 12, 2024 17:15
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

Successfully merging this pull request may close these issues.

Standardize language: duration vs n_timepoints
3 participants