Skip to content

Commit a47cec7

Browse files
authored
Merge pull request #335 from hyanwong/docs-typos
Correct a few more typos
2 parents a79051a + 7af83a9 commit a47cec7

File tree

4 files changed

+13
-11
lines changed

4 files changed

+13
-11
lines changed

docs/historical_samples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ kernelspec:
1919

2020
# Historical (Ancient) Samples
2121

22-
Sometimes we wich to infer and date a genetic genealogy from
22+
Sometimes you may wish to infer and date a genetic genealogy from
2323
data which includes *historical samples*,
2424
whose time is older that the current generation (i.e. sample nodes with
2525
times > 0).
@@ -33,7 +33,7 @@ place any historical samples.
3333
## The 2 step approach
3434

3535
Currently, the best way to date such tree sequences is
36-
to carry out a two step process, in which inference and dating is first
36+
to perform a two step process, in which inference and dating is first
3737
performed on the modern samples in order to establish a timescale, followed by
3838
adding the historical samples and re-inferring using the dated timescale as a
3939
basis for site ages in the `tsinfer` algorithm. The re-inferred tree sequence

docs/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ svg2 = tsdate.date(inferred, population_size=1000, mutation_rate=4e-6).draw_svg(
8181
haps = "<br>".join(ts.haplotypes())
8282
cen = 'style="text-align: center; padding: 0.5em 0"'
8383
HTML(f"""<table>
84-
<caption>An example of using `tsinfer` followed by `tsdate` on some DNA sequence data.
84+
<caption style="padding: 0 4em">An example of using `tsinfer` followed by `tsdate` on some DNA sequence data.
8585
You can see that tsdate sets a timescale and changes node times so that mutations (red crosses)
8686
are more evenly distributed over edges of the genealogy. This results in more realistic local trees
87-
(with coaleascences clustered, as expected from theory, at recent times)</caption>
87+
(with coalescences clustered, as expected from theory, at recent times)</caption>
8888
<t style=""><td {cen}><div style="font-size: 0.6em">{haps}</div></td><td></td><td {cen} width="300">{svg1}</td><td></td><td {cen} width="300">{svg2}</td></tr>
8989
<tr style="font-size: 2em"><td {cen}">DNA sequence</td><td {cen}>→</td><td {cen}>tsinfer</td><td {cen}>→</td><td {cen}>tsdate</td></tr>
9090
</table>"""

docs/usage.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,11 @@ posteriors_df = pd.DataFrame(posteriors)
173173
posteriors_df.head() # Show the dataframe
174174
```
175175

176-
Since we are using a {ref}`sec_methods_discrete_time` method, each row of this
177-
posterior dataframe corresponds to a set of probabilities for a given timeslice
178-
(as specified in the `start_time` and `end_time` columns). Each column corresponds to
179-
a node (the column header is the node ID in the returned tree sequence).
176+
Since we are using a {ref}`sec_methods_discrete_time` method, each node
177+
(numbered column of the dataframe) is associated with a vector of probabilities
178+
that sum to one: each cell gives the probability that the time of the node
179+
whose ID is given by the column header lies within the
180+
timeslice specified by the `start_time` and `end_time` columns.
180181

181182
(sec_usage_popsize)=
182183

docs/variable_popsize.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ specified time intervals). This can them be used to create a prior, via the {fun
7676
function (see {ref}`sec_priors`).
7777

7878
For example, the following code defines a population that is of effective size
79-
1 million in the last 200 generations, only two hundred for a period of 10 generations 50,000 generations ago, then
80-
of size 50,000 for all generations before that, exactly matching the simulated bottleneck
79+
1 million in the last 50,000 generations, only two hundred for a period of 10 generations 50,000 generations ago, then
80+
of size 10,000 for all generations before that, exactly matching the simulated bottleneck
8181

8282
```{code-cell} ipython3
8383
popsize = tsdate.demography.PopulationSizeHistory(population_size=[1e6, 2e2, 1e4], time_breaks=[50_000, 50_010])
@@ -99,5 +99,6 @@ population size over time, by extimating the number of coalescence points in dif
9999
intervals, and re-estimating the dates. However, this
100100
approach has not been fully tested or documented.
101101

102-
If you are interested in doing this, see https://github.com/tskit-dev/tsdate/issues/237#issuecomment-1785655708
102+
If you are interested in doing this, see
103+
[GitHub issue #237](https://github.com/tskit-dev/tsdate/issues/237#issuecomment-1785655708)
103104
for an example.

0 commit comments

Comments
 (0)