Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unifying stat method desc and linking to math summary #3005

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Unifying stat method desc and linking to math summary #3005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76074ce
Unifying stat method descriptions and linking to math equation summar…
gregorgorjanc Sep 28, 2024
6371edc
Revise the edits
gregorgorjanc Oct 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Note that `tskit` provides a unified interface for computing so-called
well as a standard method for specifying "multi-way" statistics that are calculated
over many combinations of sets of samples simultaneously.

Please see the {ref}`tutorial <tutorials:sec_tutorial_stats>` for examples of the
See the {ref}`tutorial <tutorials:sec_tutorial_stats>` for examples of the
statistics API in use.

:::{warning}
Expand Down Expand Up @@ -194,7 +194,7 @@ output array is defined in a simple and intuitive manner by the
parameters provided. The {ref}`sec_stats_output_dimensions` section
defines the rules that are used.

Please see the {ref}`tutorial <sec_tutorial_stats>` for examples of the
See the {ref}`tutorial <sec_tutorial_stats>` for examples of the
statistics API in use.


Expand Down Expand Up @@ -385,7 +385,7 @@ There are some shortcuts to other useful options:
sequence. As the first returned array contains only a single
value, we drop this dimension as described in the
{ref}`output dimensions <sec_stats_output_dimensions>` section. **Note:** if you
really do want to have an array with a single value as the result, please use
really do want to have an array with a single value as the result, use
`windows = [0.0, ts.sequence_length]`.

`windows = "trees"`
Expand Down Expand Up @@ -523,7 +523,7 @@ the dimensions of the output". Note that dropping these dimensions is
**optional**: it is always possible to keep the full dimensions of the
output arrays.

Please see the {ref}`tutorial <sec_tutorial_stats>` for examples of the
See the {ref}`tutorial <sec_tutorial_stats>` for examples of the
various output dimension options.


Expand Down
Loading
Loading