tskit icon indicating copy to clipboard operation
tskit copied to clipboard

`tskit.write_ms` is not documented

Open petrelharp opened this issue 4 years ago • 4 comments

The top-level tskit.write_ms() method, added in #854, does not appear in the online documentation anywhere, although it is documented (eg help(tskit.write_ms) works).

I think this should go in a subsection of python-api; perhaps a separate top-level section labeled "Output to other formats" (that would also mention TreeSequence.write_vcf) for maximum discoverability.

petrelharp avatar May 24 '21 21:05 petrelharp

This was intentional - there are aspects of the format that we were not sure of and wanted more feedback that we were doing the right thing. It was also debated if methods such as this actually belong in tsconvert.

benjeffery avatar May 25 '21 09:05 benjeffery

Ah - missed that, sorry. I think this would make sense in tsconvert. I'm going to leave this open, though, so we remember to do it.

petrelharp avatar May 25 '21 15:05 petrelharp

hey if y'all want feedback about the ms output format-- i might be able to help

andrewkern avatar Oct 28 '25 03:10 andrewkern

Not sure it's worth the effort? Do people want/need this today?

jeromekelleher avatar Oct 31 '25 20:10 jeromekelleher