pmckenz1 / ipcoal

Simulation package for getting gene tree distributions and loci / SNPs from input tree topologies and migration / Ne scenarios. Wraps around msprime.
MIT License
12 stars 7 forks source link

Documentation/Jupyter notebooks not uptodate #26

Open mkandziora opened 4 years ago

mkandziora commented 4 years ago

Dear Patrick, dear Eaton Lab members,

Thank you very much for this very useful package. I wanted to let you know, that the documentation on readthedocs as well as the jupyter notebooks do not seem to be uptodate anymore. There seem to have been some updates to the code - which are not fully covered and which makes it harder to get started.

See for example the differences between FAQ and the effective population size page - I get an error for the later:

FAQ: ndict = {i: 1e4 for i in (1, 2, 3, 5, 7)} newtre = tre.set_node_values("Ne", default=1e5, values=ndict)

readthedocs: tre = tre.set_node_values( attr="Ne",

the branches above these nodes get specific values

values={8: 5e6, 6: 5e6, 2: 5e6},
# the rest of the branches take this default value
default=20,

)

There seem to be a few more updates, e.g. 'draw_tree_grid' does not exist anymore (?).

Martha