Skip to content

Commit 3503a28

Browse files
authored
Update README.rst
Add a FAQ about how to read the recombination rate
1 parent 1858d07 commit 3503a28

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -435,11 +435,11 @@ requires additional regularization.
435435

436436
Frequently asked questions
437437
==========================
438-
The binary installer dies with the error message::
438+
1. *The binary installer dies with the error message*::
439439

440-
ImportError: /lib64/libc.so.6: version `GLIBC_2.14' not found (required by ...).
440+
ImportError: /lib64/libc.so.6: version `GLIBC_2.14' not found (required by ...).
441441

442-
How can I fix this?
442+
*How can I fix this*?
443443

444444
This is due to a ``glibc`` version mismatch between your system and
445445
the build server I use to create the binary installers. Unfortunately,
@@ -450,8 +450,8 @@ How can I fix this?
450450
linking a different version of ``glibc`` at runtime is **not** supported,
451451
and will likely cause random crashes.
452452

453-
SMC++ claims that my population crashed in the very recent past. What's
454-
going on?
453+
2. *SMC++ claims that my population crashed in the very recent past. What's
454+
going on*?
455455

456456
Typically this is due to long runs of homozygosity (ROH) in the data, which can arise for
457457
one of several reasons:
@@ -461,7 +461,13 @@ going on?
461461
3. Uncalled regions in your VCF were not marked as such before running vcf2smc_.
462462

463463
#1 represents real signal, while #2 and #3 should be filtered out using the ``-m``
464-
option of vcf2smc_ and/or the ``-c`` option of estimate_.
464+
option of vcf2smc_ and/or the ``-c`` option of estimate_.-
465+
466+
3. *How do I get the estimated recombination rate*?
467+
468+
The ``model.final.json`` output file contains fields named ``rho`` and ``N0``. ``rho`` is
469+
the estimated population-scaled recombination rate per base-pair.
470+
To convert it to units of generations, multiply by ``2 * N0``.
465471

466472

467473
What to do if you encounter trouble

0 commit comments

Comments
 (0)