Skip to content

Commit af14bf8

Browse files
authored
Make the README and docs intro more "ARG"y (#3332)
Moving to a phrasing where the tree sequence is a format for storing genetic genealogies / ARGs. Now that we have the ARG interface (for going up and down the ARG), perhaps we don't want to say that the encoding is focussed on storing the correlated trees?
1 parent 5ffcf6f commit af14bf8

File tree

2 files changed

+18
-20
lines changed

2 files changed

+18
-20
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,21 @@
1111
[![Docs Build](https://github.com/tskit-dev/tskit/actions/workflows/docs.yml/badge.svg)](https://github.com/tskit-dev/tskit/actions/workflows/docs.yml) [![Binary wheels](https://github.com/tskit-dev/tskit/actions/workflows/wheels.yml/badge.svg)](https://github.com/tskit-dev/tskit/actions/workflows/wheels.yml) [![Tests](https://github.com/tskit-dev/tskit/actions/workflows/tests.yml/badge.svg)](https://github.com/tskit-dev/tskit/actions/workflows/tests.yml)
1212

1313

14-
Succinct tree sequences are a highly efficient way of storing a set of related DNA
15-
sequences by encoding their ancestral history as a set of correlated trees along the
16-
genome. The tree sequence format is output by a number of software libraries and programs
17-
(such as [msprime](https://github.com/tskit-dev/msprime),
14+
The succinct tree sequence (`tskit) format is an efficient way of representing
15+
the genetic history - sometimes known as an Ancestral Recombination Graph or ARG -
16+
of a set of related DNA sequences. `Tskit` is used
17+
by a number of software libraries and programs (such as
18+
[msprime](https://github.com/tskit-dev/msprime),
1819
[SLiM](https://github.com/MesserLab/SLiM),
1920
[fwdpp](http://molpopgen.github.io/fwdpp/), and
2021
[tsinfer](https://tskit.dev/tsinfer/docs/stable/)) that either simulate or infer
21-
the evolutionary history of genetic sequences. The evolutionary history of genetic
22-
sequences is often technically referred to as an Ancestral Recombination Graph (ARG);
23-
succinct tree sequences are fully compatible with this formulation, and tskit is a
24-
therefore a powerful platform for processing ARGs.
22+
the evolutionary ancestry of genetic sequences.
2523

2624
The `tskit` library provides the underlying functionality used to load, examine, and
27-
manipulate tree sequences, including efficient methods for calculating genetic
28-
statistics. It often forms part of an installation of other software packages such as
29-
those listed above. Please see the
25+
manipulate ARGs in the tree sequence format, including efficient access to the
26+
sequence of correlated trees along a genome and general methods to calculate
27+
genetic statistics. `Tskit` often forms part of an installation of other
28+
software packages such as those listed above. Please see the
3029
[documentation](https://tskit.dev/tskit/docs/stable/) for further details, which
3130
includes
3231
[installation instructions](https://tskit.dev/tskit/docs/stable/installation.html).

docs/introduction.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,25 @@ kernelspec:
1818

1919
# Introduction
2020

21-
This is the documentation for `tskit`, the tree sequence toolkit. Succinct tree sequences
22-
provide a highly efficient way of storing a set of related DNA sequences by encoding
23-
their ancestral history as a set of correlated trees along the genome. The evolutionary
24-
history of genetic sequences is often technically referred to as an Ancestral
25-
Recombination Graph (ARG); succinct tree sequences are fully compatible with this
26-
formulation, and tskit is a therefore a powerful platform for processing ARGs.
21+
This is the documentation for `tskit`, the tree sequence toolkit.
22+
Succinct tree sequences are an efficient way of representing the
23+
genetic history - often technically referred to as an Ancestral
24+
Recombination Graph or ARG - of a set of DNA sequences.
2725

2826
The tree sequence format is output by a number of external software libraries
2927
and programs (such as [msprime](https://tskit.dev/msprime/docs),
3028
[SLiM](https://github.com/MesserLab/SLiM),
3129
[fwdpp](https://fwdpp.readthedocs.io/en/), and
3230
[tsinfer](https://tskit.dev/tsinfer/docs/)) that either simulate or
33-
infer the evolutionary history of genetic sequences. This library provides the
31+
infer the evolutionary ancestry of genetic sequences. This library provides the
3432
underlying functionality that such software uses to load, examine, and
35-
manipulate tree sequences, including efficient methods for calculating
33+
manipulate ARGs in tree sequence format, including efficient access to the
34+
correlated sequence of trees along a genome and general methods to calculate
3635
{ref}`genetic statistics<sec_stats>`.
3736

3837
For a gentle introduction, you might like to read "{ref}`tutorials:sec_what_is`"
3938
on our {ref}`tutorials site<tutorials:sec_intro>`. There you can also find further
40-
tutorial material to introduce you to the key concepts behind succinct tree sequences.
39+
tutorial material to introduce you to key `tskit` concepts.
4140

4241
:::{important}
4342
If you use `tskit` in your work, please remember to cite it appropriately: see the {ref}`citations<sec_citation>` page for details.

0 commit comments

Comments
 (0)