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

Create a common contact data class across packages #55

Open
Bisaloo opened this issue Sep 7, 2022 · 4 comments
Open

Create a common contact data class across packages #55

Bisaloo opened this issue Sep 7, 2022 · 4 comments

Comments

@Bisaloo
Copy link
Member

Bisaloo commented Sep 7, 2022

I think the different packages fill different niches and it's good to keep them all alive (especially since they are already on CRAN).

However, we should make sure that they play well together and that it is easy for users to go from one to the other.

It might also be useful to provide a shared S3 class for contact matrices so we can write common methods.

See also: Bisaloo/contactdata#2

@sbfnk
Copy link
Collaborator

sbfnk commented Sep 14, 2022

I think the two packages fill 2 different niches and it's good to keep them both alive (especially since both of them are already on CRAN).

I'm not 100% convinced that they need to be separate but if yes then it would indeed be a great idea to streamline the interface to be similar. We might also want to consider whether they could be named better to make the distinction clearer (as socialmixr handles "contact data" and contacdata provides estimates of social mixing).

It might also be useful to provide a shared S3 class for contact matrices so we can write common methods.

That is a good idea I think.

@Bisaloo
Copy link
Member Author

Bisaloo commented Oct 11, 2022

Outcome from the discussion that happened on slack:

It looks we heading towards a separate package which will provide a constructor and other methods (print(), plot(), accessor functions, etc.) for the S3 class we defined.

The maintainers of the individual packages keep the responsibility to convert their objects to the common class.

This means we should probably sync with conmat devs to see if:

  • they would be willing to eventually update their package to use the common class
  • they already have opinions on how we should build the class.

@njtierney
Copy link

Hi there 👋

Just chiming in to notify myself of this discussion, and also tagging in the other conmat devs, @goldingn, and @aarathybabu97

@Bisaloo Bisaloo changed the title Unify contactdata and socialmixr Create a common contact data class across packages Oct 24, 2022
@TimTaylor
Copy link
Contributor

As above. Commenting for notifications on progress here.

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