Skip to content

Commit d8dbbd3

Browse files
committed
updated xerxes docs
1 parent 2c5569a commit d8dbbd3

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

xerxes.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ On GitHub you will also find [older release versions](https://github.com/poseido
3131

3232
With `xerxes --help` and `xerxes <subcommand> --help` you can get information about each subcommand and parameter directly on the command line. The guide below explains the subcommands in more detail. It is available in .pdf format for the current and previous versions here:
3333

34-
- [🗎 Guide for xerxes v1.0.1.0 to v1.0.1.1](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes.pdf) (shown below)
34+
- [🗎 Guide for xerxes v1.0.1.0 or higher](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes.pdf) (shown below)
3535
- [🗎 Guide for xerxes v1.0.0.2](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes_guide_archive/xerxes_guide_1.0.0.2.pdf)
3636
- [🗎 Guide for xerxes v0.2.0.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes_guide_archive/xerxes_guide_0.2.0.0.pdf)
3737

@@ -52,7 +52,7 @@ Here is an example command for computing several F-Statistics:
5252
```bash
5353
xerxes fstats -d ... -d ... \
5454
--stat "F4(<Chimp.REF>, <Altai_published.DG>, Yoruba, French)" \
55-
--stat "F3(<Chimp.REF>, <Altai_snpAD.DG>, Spanish)" \
55+
--stat "F3(<Altai_snpAD.DG>, Spanish, <Chimp.REF>)" \
5656
--statFile fstats.txt
5757
--statConfig fstats.yaml
5858
-f outputfile.txt
@@ -69,10 +69,13 @@ These three modes of input can be mixed and matched, and even given multiple tim
6969
Last, the option `-f` can be used to write the output table into a tab-separated text file, beyond just printing a table into the standard out when the program finishes. Note that there are more options, which you can view using `xerxes fstats --help`:
7070

7171
```default
72-
Usage: xerxes fstats (-d|--baseDir DIR) [-j|--jackknife ARG]
73-
[-e|--excludeChroms ARG]
74-
(--stat ARG | --statConfig ARG | --statFile ARG)
75-
[--noTransitions] [-f|--tableOutFile ARG]
72+
xerxes v1.0.1.2 for poseidon v2.5.0, v2.6.0, v2.7.0, v2.7.1
73+
https://poseidon-framework.github.io
74+
75+
Usage: xerxes fstats (-d|--baseDir DIR) [-j|--jackknife ARG]
76+
[-e|--excludeChroms ARG]
77+
(--stat ARG | --statConfig ARG | --statFile ARG)
78+
[--noTransitions] [-f|--tableOutFile ARG]
7679
[--blockTableFile ARG]
7780
7881
Compute f-statistics on groups and invidiuals within and across Poseidon

0 commit comments

Comments
 (0)