sgkit-dev / sgkit

Scalable genetics toolkit
https://sgkit-dev.github.io/sgkit
Apache License 2.0
231 stars 32 forks source link

"missing_pct" misnamed in simulate_genotype_call_dataset #1172

Open hyanwong opened 8 months ago

hyanwong commented 8 months ago

simulate_genotype_call_dataset says:

missing_pct The percentage of missing calls, must be within [0.0, 1.0], optional

But 0..1 isn't a percentage, it's a proportion or fraction. So I guess this should be renamed "missing_frac" or "missing_prop", (and maybe missing_pct could be deprecated but retained for backwards compatibility)