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

Jump to bottom

add conda install instructions noting error message #87

Merged
merged 2 commits into from
Feb 26, 2021
Merged

add conda install instructions noting error message #87

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
0ab74c7
add conda install instructions noting error message
hdashnow Feb 25, 2021
6525f10
add link back to GitHub repo
hdashnow Feb 26, 2021
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
2 changes: 2 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
Welcome to STRling's documentation!
===================================

STRling code: https://github.com/quinlan-lab/STRling

STRling (pronounced like “sterling”) is a method to detect large STR expansions from short-read sequencing data. It is capable of detecting novel STR expansions, that is expansions where there is no STR in the reference genome at that position (or a different repeat unit from what is in the reference). It can also detect STR expansions that are annotated in the reference genome. STRling uses kmer counting to recover mis-mapped STR reads. It then uses soft-clipped reads to precisely discover the position of the STR expansion in the reference genome.

.. toctree::
Expand Down
6 changes: 6 additions & 0 deletions docs/source/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ We suggest conda installation if you want to perform outlier analysis, which req
conda config --add channels bioconda
conda install -y strling

The following should now be in your path:
`strling`
`strling-outliers.py`

Note: It should be safe to ignore "Solving environment: failed ..." messages as long as the message "Solving environment: done" appears following the failed message and the install proceeds.

Install from source
-------------------

Expand Down