Merge pull request #1689 from benjeffery/roadmap

Add draft roadmap

Author: mergify[bot]

README.md

@@ -7,13 +7,30 @@
 ![OS](https://img.shields.io/badge/OS-linux%20%7C%20OSX%20%7C%20win--64-steelblue)
 
 
-Succinct tree sequences are a highly efficient way of storing a set of related DNA sequences by encoding their ancestral history as a set of correlated trees along the genome. The tree sequence format is output by a number of software libraries and programs (such as [msprime](https://github.com/tskit-dev/msprime), [SLiM](https://github.com/MesserLab/SLiM), [fwdpp](http://molpopgen.github.io/fwdpp/), and [tsinfer](https://tsinfer.readthedocs.io/en/latest/)) that either simulate or infer the evolutionary history of genetic sequences.
+Succinct tree sequences are a highly efficient way of storing a set of related DNA
+sequences by encoding their ancestral history as a set of correlated trees along the
+genome. The tree sequence format is output by a number of software libraries and programs
+(such as [msprime](https://github.com/tskit-dev/msprime), [SLiM](https://github.com/MesserLab/SLiM), [fwdpp](http://molpopgen.github.io/fwdpp/), and [tsinfer](https://tsinfer.readthedocs.io/en/latest/)) that either simulate or infer the evolutionary history of genetic sequences.
 
-The `tskit` library provides the underlying functionality used to load, examine, and manipulate tree sequences, including efficient methods for calculating genetic statistics. It often forms part of an installation of other software packages such as those listed above. Please see the [documentation](https://tskit.readthedocs.io/en/latest/) for further details, which includes [installation instructions](https://tskit.readthedocs.io/en/latest/installation.html).
+The `tskit` library provides the underlying functionality used to load, examine, and
+manipulate tree sequences, including efficient methods for calculating genetic
+statistics. It often forms part of an installation of other software packages such as
+those listed above. Please see the
+[documentation](https://tskit.readthedocs.io/en/latest/) for further details, which
+includes
+[installation instructions](https://tskit.readthedocs.io/en/latest/installation.html).
+See the [road map](https://github.com/tskit-dev/tskit/blob/main/ROADMAP.md)
 
-To get started with tskit, tutorials and other content are at http://tskit.dev. For help and support from the community you can use [discussions](https://github.com/tskit-dev/tskit/discussions) here on github, or raise an issue for a specific bug or feature request.
+To get started with tskit, tutorials and other content are at http://tskit.dev. For help
+and support from the community you can use
+[discussions](https://github.com/tskit-dev/tskit/discussions) here on github, or raise an
+issue for a specific bug or feature request.
 
-The base `tskit` library provides both a Python and C API. A Rust API is provided in the [tskit-rust](https://github.com/tskit-dev/tskit-rust) repository.
+tskit warmly welcomes contributions from the community. Raise an issue if you have an
+idea you'd like to work on, or submit a PR for comments and help.
+
+The base `tskit` library provides both a Python and C API. A Rust API is provided in the
+[tskit-rust](https://github.com/tskit-dev/tskit-rust) repository.
 
 
 #### Python API
@@ -23,10 +40,15 @@ The base `tskit` library provides both a Python and C API. A Rust API is provide
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Travis](https://img.shields.io/travis/tskit-dev/tskit)](https://travis-ci.org/github/tskit-dev/tskit)
 
-Most users of `tskit` will use the python API as it provides a convenient, high-level API to access, analyse and create tree sequences. Full documentation is [here](https://tskit.readthedocs.io/en/latest/python-api.html).   
+Most users of `tskit` will use the python API as it provides a convenient, high-level API
+to access, analyse and create tree sequences. Full documentation is
+[here](https://tskit.readthedocs.io/en/latest/python-api.html).   
 
 #### C API
 [![C99](https://img.shields.io/badge/Language-C99-steelblue.svg)](https://en.wikipedia.org/wiki/C99)
 [![CircleCI](https://circleci.com/gh/tskit-dev/tskit.svg?style=shield)](https://circleci.com/gh/tskit-dev/tskit)
 
-The `tskit` C API provides comprehensive, low-level methods for manipulating and processing tree-sequences. Written to the C99 standard and fully thread-safe, it can be used with either C or C++. Full documentation is [here](https://tskit.readthedocs.io/en/latest/c-api.html).
+The `tskit` C API provides comprehensive, low-level methods for manipulating and
+processing tree-sequences. Written to the C99 standard and fully thread-safe, it can be
+used with either C or C++. Full documentation is
+[here](https://tskit.readthedocs.io/en/latest/c-api.html).

ROADMAP.md

@@ -0,0 +1,33 @@
+This roadmap is a rough plan of upcoming work. Contributions are welcome at anytime,
+no matter where something is on this list.
+
+## Next release
+###[Python 0.3.8](https://github.com/tskit-dev/tskit/milestone/26) and [C 0.99.15](https://github.com/tskit-dev/tskit/milestone/28) 
+- Complete IBD features [(project)](https://github.com/tskit-dev/tskit/projects/8)
+- Large 64bit metadata columns (Python, already in C 0.99.14)
+- Small additions cleanup and bugfixes (see milestone [issue list](https://github.com/tskit-dev/tskit/milestone/26))
+
+## Nearterm goals
+
+### [C API 1.0](https://github.com/tskit-dev/tskit/milestone/1)
+- Document all structs and methods that will be stable and supported indefinitely 
+- Remove legacy cruft
+- Other clean up including sorting bugs and small features  (see milestone issue list)
+
+## Medium term priorities
+
+### [Metadata](https://github.com/tskit-dev/tskit/projects/7)
+ - Improve user experience by adding convenience methods for updating, retrieving metadata and schemas
+ - Codec performance
+ - Standardised schemas
+
+### [Stats API](https://github.com/tskit-dev/tskit/projects/6)
+ - Added stats and options
+ - Improve errors
+ - (Fully deal with missing data)[https://github.com/tskit-dev/tskit/issues/287]
+ - Time windowed statistics
+
+### [Random Tree Access](https://github.com/tskit-dev/tskit/projects/5)
+ - Build indexes to allow performant random tree access
+
+### [Reference Sequence support](https://github.com/tskit-dev/tskit/issues/146)