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

Statement of Need #3

Closed
paulgovan opened this issue Mar 9, 2020 · 8 comments
Closed

Statement of Need #3

paulgovan opened this issue Mar 9, 2020 · 8 comments

Comments

@paulgovan
Copy link

This issue is for github.com/openjournals/joss-reviews/issues/2111.

There is not a clear "statement of need" in either the package documentation or the journal paper. Both provide a description of what the package is useful for, but not necessarily why this package is necessary as opposed to other BGGM software.

@jayrobwilliams
Copy link

jayrobwilliams commented May 21, 2020

It's not immediately clear from the updated README and paper what the main use and targeted audience is for the package. You can figure this out by reading through the examples, but there should be an explicit setence(s) that spell out what types of problems in which fields this package is intended for, as this is a very specific type of model.

@donaldRwilliams
Copy link
Owner

Ok. I will add this to the paper and Readme
later today.

@donaldRwilliams
Copy link
Owner

To follow up on this @jayrobwilliams , I am having a difficult time coming up with a target audience that does not also limit the audience. Really any one that would want to estimate a GGM can use the methods, although it was developed by someone in the social behavioral sciences, if this makes sense.

Anyhow, open to suggestions.

@jayrobwilliams
Copy link

I think a list of disciplines that commonly employ GGMs with a citation or two for canonical examples of articles that use GGMs would be sufficient for me. The state of the field discussion and comparison to existing packages goes a long way here, but I think a clearly stated example of a problem or two that GGMs are used for in the intro of the paper and README would make the need for BGGM crystal clear.

@donaldRwilliams
Copy link
Owner

Ok. I will add this !

@donaldRwilliams
Copy link
Owner

To address this comment, we added two sections. The first (What is a Gaussian Graphical Model) stated what a GGM is. And then the second ("Applications") listed several applications with references.

@jayrobwilliams
Copy link

This is great! Clearly and concisely helps the reader understand what you might want to use a GGM for.

@donaldRwilliams
Copy link
Owner

To address this comment, we clearly stated the need for the package in the paper and the README. This included showcasing examples with actual data and comparisons to other packages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants