popsim-consortium / stdpopsim

A library of standard population genetic models
GNU General Public License v3.0
127 stars 88 forks source link

add info about type of data used to demographic model descriptions #1442

Open petrelharp opened 1 year ago

petrelharp commented 1 year ago

As suggested by a reviewer, it'd provide helpful context to say what sort of data was used to fit the demographic models, so users can guess how what aspects of the data simulations are expected to recapitulate. As discussed in the meeting, it'd be nice to add this to the descriptions of the models. I don't think this should be extensive, and we do a little of this already; along the lines of "inferred from site frequency spectrum data using dadi" or "inferred by simulation-based deep learning using genotype matrices"; for the real details one will have to look at the original paper.

In fact, it might be too hard to actually provide a sufficiently useful and accurate summary; so maybe this is not useful? But if we think it is, then we need to

gregorgorjanc commented 1 month ago

Isn’t this obvious from citations for the used parameters? Users could read citations and get the information they are after.