elissasoroj / shadie

GNU General Public License v3.0
11 stars 4 forks source link

Improve name for "sex" argument in wrightfisher model #21

Closed eaton-lab closed 4 months ago

eaton-lab commented 5 months ago

This example would make it more clear that the type is binary and it is defining separate versus non-separate sexes. It is also more clear that this does not mean sex versus asexual, or other such things.

model.reproduction.wright_fisher(separate_sexes=True)

Instead of

model.reproduction.wright_fisher(sex=True)
eaton-lab commented 5 months ago

I see that the 'sex' argument exists for the wright_fisher_haploid_clonal model. Since it only reproduces clonally this argument should probably not exist.

elissasoroj commented 4 months ago

Fixed in v1.0.1 release