search

popsim-consortium / stdpopsim

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

Various issues in the docs to be resolved by the "selection release" #1403

Open igronau opened 2 years ago

igronau commented 2 years ago
  1. When adding a new species, should we require that the original contributor also generate tables for the docs, as done when a new demographic model is added?
  2. The development docs do not currently mention anything about non-crossover recombination: not the special case of bacteria and archaea, and not gene conversion. We should probably mention this somewhere in our instructions for adding new species. Maybe a short section after Coding the species parameters?
  3. What's the review process when adding a new genetic map? Is it done behind the scenes between the contributor and the uploader? What types of things should be checked?
  4. Review the section about adding DFE models to make sure it has sufficient and correct details. Especially in the section about the review process, which is currently quite vague. Also, add some local tests to be run before submitting the initial PR (similar to what's done for demographic models).
igronau commented 2 years ago

Regarding docs for new species, @petrelharp notes that species-tables that appear in the docs are automatically generated.

igronau commented 1 year ago

We also need to briefly mention gene conversion in the 'add species' portion of the docs + link to detailed docs in api