Skip to content

Commit

Permalink
add preprint to docs/readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hdashnow committed Nov 22, 2021
1 parent 74abfa1 commit 41d9d4e
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,11 @@ STRling (pronounced like “sterling”) is a method to detect large STR expansi
## Install and Run STRling

Please see the [STRling Documentation](https://strling.readthedocs.io/en/latest/) for installation and running instructions.

## Citation

For more details able the algorithm check out our paper.

If using STRling, please cite:

Dashnow H, Pedersen BS, Hiatt L, Brown J, Beecroft SJ, Ravenscroft G, et al. STRling: a k-mer counting approach that detects short tandem repeat expansions at known and novel loci [Internet]. bioRxiv. 2021. Available from: [doi:10.1101/2021.11.18.469113](https://doi.org/10.1101/2021.11.18.469113)
15 changes: 15 additions & 0 deletions docs/source/cite.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Cite
====

.. toctree::
:maxdepth: 2
:caption: Contents:


STRling paper
-------------

For more details on the STRling algorithm, or if use use our software, please cite:

Dashnow H, Pedersen BS, Hiatt L, Brown J, Beecroft SJ, Ravenscroft G, et al. STRling: a k-mer counting approach that detects short tandem repeat expansions at known and novel loci [Internet]. bioRxiv. 2021. Available from: `doi:10.1101/2021.11.18.469113 <https://doi.org/10.1101/2021.11.18.469113>`_

1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ STRling (pronounced like “sterling”) is a method to detect large STR expansi
test
debug
contribute
cite


Quick start
Expand Down

0 comments on commit 41d9d4e

Please sign in to comment.