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

Possible name change for vb_epidist class #93

Closed
joshwlambert opened this issue Feb 7, 2023 · 8 comments
Closed

Possible name change for vb_epidist class #93

joshwlambert opened this issue Feb 7, 2023 · 8 comments

Comments

@joshwlambert
Copy link
Member

The vb_epidist class currently has two slots called intrinsic_epidist and extrinsic_epidist. It has been pointed out that these might be unclear and perhaps human_epidist and vector_epidist would be clearer. I'm unsure of which is preferred. Please comment on this issue with any preference.

@joshwlambert joshwlambert added help wanted Extra attention is needed question Further information is requested labels Feb 7, 2023
@joshwlambert joshwlambert added the dev day Issues for the {epiparameter} development day label Feb 13, 2024
@joshwlambert
Copy link
Member Author

Tagging with dev day for discussion on {epiparameter} development day.

@joshwlambert joshwlambert removed the dev day Issues for the {epiparameter} development day label Jun 12, 2024
@joshwlambert
Copy link
Member Author

I'm questioning whether the {epiparameter} package should contain a <vb_epidist> class. I do not know of any current use cases where this class or it's functionality is used/required.

The <vb_epidist> plotting method was already removed in #315.

@Bisaloo and @chartgerink in terms of development I'm hoping to simplify and streamline {epiparameter} over the next few weeks. Do you agree with removing this?

@avallecam and @CarmenTamayo do you use <vb_epidist> in any scripts or training material?

@Bisaloo
Copy link
Member

Bisaloo commented Jun 12, 2024

To clarify, epidemiological parameters for vector-borne diseases can still be included in epiparameter but as "simple" epidist objects. Is this correct?

So, what we would be losing here is the fact that the human_epidist and vector_epidist have been estimated together and it's probably unreliable to use human_epidist from one study with vector_epidist from another study. Am I getting this right as well?

@joshwlambert
Copy link
Member Author

To clarify, epidemiological parameters for vector-borne diseases can still be included in epiparameter but as "simple" epidist objects. Is this correct?

Yes.

So, what we would be losing here is the fact that the human_epidist and vector_epidist have been estimated together and it's probably unreliable to use human_epidist from one study with vector_epidist from another study. Am I getting this right as well?

Yes, plus the S3 methods for the class which are apply the <epidist> methods to both the human and vector <epidist>s.

The reasoning behind adding the <vb_epidist> class was to allow intrinsic (human_epidist) and extrinsic (vector_epidist) to be jointly handled, with a planned addition for epidist_db() to return a <vb_epidist> if the two returned <epidist> objects are linked, but this never materialised.

The intrinsic and extrinsic parameters are linked by the extrinsic and transmission_mode in the <epidist> metadata.

For linking human and vector parameters from different studies, I think we can leave this to users of the package.

@chartgerink
Copy link
Member

I'm all for streamlining in case keeps scope of the functionality the same. I did a bit of code-browsing and do not see any immediate issues.

As the maintainer @joshwlambert I trust your final judgment on the applicability 👍 Appreciate being pinged and looped in 😊

@Bisaloo
Copy link
Member

Bisaloo commented Jun 13, 2024

I agree that using the epidist class for everything is reasonable then 👍, with potentially a small note in a vignette highlighting the potential statistical pitfalls when not using the linked distribution.

@avallecam
Copy link
Member

avallecam commented Jun 14, 2024

@avallecam and @CarmenTamayo do you use <vb_epidist> in any scripts or training material?

Not until now. We do not have any case study based on vector-borne diseases yet, as far as I'm aware. In order to provide informed feedback to this issue, we should plan to find a used case for this.

@joshwlambert joshwlambert removed help wanted Extra attention is needed question Further information is requested labels Jun 28, 2024
@joshwlambert
Copy link
Member Author

Closing as this issue was addressed in #359.

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

4 participants