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

Improve description of the package, add examples, and use cases across disciplines (JOSS paper) #321

Closed
PetrKorab opened this issue Sep 4, 2024 · 2 comments · Fixed by #337

Comments

@PetrKorab
Copy link

The package has detailed documentation, but the paper is quite difficult to read for a non-specialist audience, mainly in the second part. Please add example use cases of the package for researchers in various areas and leave part of the technicalities for the documentation.

It will help researchers across disciplines better understand the benefits of the package. Thanks!

@misken
Copy link

misken commented Sep 5, 2024

I concur. The documentation is quite detailed and no need to try to put too much of it into the paper. Specific usage examples from different domains might help readers envision their own use cases for metasyn.

@misken
Copy link

misken commented Sep 9, 2024

Just to follow up with a bit more on this issue. In addition to some additional specific usage examples in the paper, it would be a good future task to base some of the documentation examples on more realistic datasets. I know that many people are familiar with the Titanic dataset and it does have fields that fall into the category of things that might be necessary to obscure via tools like metasyn. However, it might really help potential users to see usage examples based on your real experience with using metasyn to create synthetic data. The fruit based examples don't really scream out for the need for synthetic data. :)

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 a pull request may close this issue.

2 participants